starlight-typedoc 📚

Starlight plugin to generate documentation from TypeScript using 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:

License

Licensed under the MIT License, Copyright © HiDeoo.

See LICENSE for more information.