Starlight plugin to generate documentation from TypeScript using TypeDoc.
Starlight plugin to generate documentation from TypeScript using TypeDoc.
Want to get started immediately? Check out the getting started guide or check out the demo to see the plugin in action.
A Starlight plugin using TypeDoc and typedoc-plugin-markdown to generate documentation from TypeScript code.
Licensed under the MIT License, Copyright © HiDeoo.
See LICENSE for more information.
HiDeoo
51d3e37 Thanks @HiDeoo! - Fixes a sidebar generation issue when using the plugin watch configuration option.2fc1bf2 Thanks @HiDeoo! - Fixes a regression introduced in version 0.21.0 that prevented the development server from starting when using the plugin watch configuration option.e447787 Thanks @HiDeoo! - Fixes a potential page and link generation issue with some declaration reference names such as a function named $.#77 751021f Thanks @HiDeoo! - ⚠️ BREAKING CHANGE: The minimum supported version of typedoc is now 0.28.0.
⚠️ BREAKING CHANGE: The minimum supported version of typedoc-plugin-markdown is now 4.6.0.
#74 2765549 Thanks @HiDeoo! - Adds a new errorOnEmptyDocumentation option, defaulting to true, to control whether the plugin should error when no TypeDoc documentation is generated.
Setting this option to false will prevent the plugin from erroring in this case which can be useful when generating documentation for multiple entry points and only some of them contain documented code at a given time.
The current behavior remains unchanged, and the plugin will error when no TypeDoc documentation is generated if the option is not explicitly set to false.
#70 8ffcff1 Thanks @HiDeoo! - ⚠️ BREAKING CHANGE: The minimum supported version of Starlight is now version 0.32.0.
Please use the @astrojs/upgrade command to upgrade your project:
npx @astrojs/upgrade#66 c4014bc Thanks @HiDeoo! - Adds support for Astro v5, drops support for Astro v4.
⚠️ BREAKING CHANGE: The minimum supported version of Starlight is now 0.30.0.
Please follow the upgrade guide to update your project.