Please note this pre-release version may contain breaking changes within the same semantic version.
A plugin for TypeDoc that renders TypeScript API documentation as Markdown.
By default, TypeDoc will render API documentation as a webpage, e.g. HTML files.
The plugin replaces the default HTML theme with a built-in Markdown theme and exposes some additional options. This is useful if documentation is required to be included in project README files, Wikis and static site generators.
npm install typedoc typedoc-plugin-markdown@next --save-devPlugins are loaded by using the plugin configuration option:
Via the command line.
typedoc --plugin typedoc-plugin-markdownUsing a typedoc.json config file or under the typedocOptions key in tsconfig.json.
{ "plugin": ["typedoc-plugin-markdown"] }Please see https://typedoc.org/options/configuration for general TypeDoc option configuration.
-
All of TypeDoc's Configuration, Input and Organization options are all respected as these are executed at the conversion phase of the project.
-
TypeDoc's Output options are relevant to the rendering phase and in the main HTML output specific and are ignored by this plugin with the exception of
--outand--cleanOutputDir.
This plugin exposes additional options. Please see Options Guide for detailed usage.
Options that define how output files are generated.
--outputFileStrategy--includeFileNumberPrefixes--flattenOutputFiles--entryFileName--indexFileName--indexPageTitle--skipIndexPage--preserveAnchorCasing--anchorPrefix
UI Options
--excludeGroups--hidePageHeader--hidePageTitle--hideBreadcrumbs--hideInPageTOC--hideHierarchy--identifiersAsCodeBlocks--propertiesFormat--enumMembersFormat--typeDeclarationFormat--tocFormat--titleTemplate
Coming soon
Contributions and suggestions are welcome. Please see the contributing guidelines for further details.