starlight-typedoc 📚

Starlight plugin to generate documentation from TypeScript using TypeDoc.

Getting Started

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

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:

See LICENSE for more information.

Name		Name	Last commit message	Last commit date
Latest commit History 156 Commits
.github/workflows		.github/workflows
.husky		.husky
docs		docs
example		example
fixtures		fixtures
packages/starlight-typedoc		packages/starlight-typedoc
.eslintrc.json		.eslintrc.json
.gitignore		.gitignore
.node-version		.node-version
.prettierignore		.prettierignore
LICENSE		LICENSE
README.md		README.md
package.json		package.json
pnpm-lock.yaml		pnpm-lock.yaml
pnpm-workspace.yaml		pnpm-workspace.yaml
tsconfig.json		tsconfig.json