starlight-typedoc
TypeScript icon, indicating that this package has built-in type declarations

0.12.1 • Public • Published

starlight-typedoc 📚

Starlight plugin to generate documentation from TypeScript using TypeDoc.

Screenshot of starlight-typedoc

Getting Started

Want to get started immediately? Check out the getting started guide.

Features

A Starlight plugin using TypeDoc and typedoc-plugin-markdown to generate documentation from TypeScript code.

Check out the example for a preview of the generated documentation.

Some TSDoc tags uses a custom Markdown syntax, e.g. the @deprecated, @alpha, @beta and @experimental tags using Starlight asides:

Screenshot of a deprecated tag in Starlight

License

Licensed under the MIT License, Copyright © HiDeoo.

See LICENSE for more information.

Package Sidebar

Install

npm i starlight-typedoc

Weekly Downloads

392

Version

0.12.1

License

MIT

Unpacked Size

25.4 kB

Total Files

9

Last publish

Collaborators

  • hideoo