A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.
npm install @cirrusct/mr-typedoc-plugin-markdown-docusaurusA plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.
The plugin will replace the default HTML theme with a built-in Markdown theme, and expose some additional arguments.
By default, the Markdown theme will attempt to render standard CommonMark, suitable for the majority of Markdown engines.
It follows the same structure and file patterns as the default HTML theme.
``bash`
npm install --save-dev typedoc typedoc-plugin-markdown
`bash`
$ npx typedoc --plugin typedoc-plugin-markdown [args]
- The --plugin arg is optional - if omitted all installed plugins will run.--plugin none
- If using with the default HTML theme or other themes, use to switch the plugin off.typedoc
- The plugin needs to be executed from the same location as . Either run as an npm script or make sure to run npx typedoc.
The following arguments can be used in addition to the default TypeDoc arguments.
- --theme
Specify the theme that should be used. Defaults to . Please read Markdown Themes for further details.--namedAnchors
-
Use HTML named anchors as fragment identifiers for engines that do not automatically assign header ids.
-
Do not print source file link rendering.
-
Do not print breadcrumbs.
-
Do not update the file when used with docusaurus` theme.