typedoc-plugin-markdown
Advanced tools
Readme
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-dev
Plugins are loaded by using the plugin configuration option:
typedoc --plugin typedoc-plugin-markdown
Please see https://typedoc.org/options/configuration.
All of TypeDoc's Configuration, Input and Organization options are respected as they are executed at the conversion phase of the project.
TypeDoc's Output options are on the whole only relevant to the HTML theme and the majority are ignored by this plugin. Supported Output options are out, cleanOutputDir.
This plugin exposes additional options. Please see Options Guide for detailed usage.
--hidePageHeader--hidePageTitle--hideBreadcrumbs--hideInPageTOC--indexPageTitle--titleTemplate--excludeGroups--useCodeBlocks--expandObjects--parametersFormat--propertiesFormat--enumMembersFormat--typeDeclarationFormat--indexFormatContributions and suggestions are welcome. Contributing guidelines coming soon.
FAQs
A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.
The npm package typedoc-plugin-markdown receives a total of 259,210 weekly downloads. As such, typedoc-plugin-markdown popularity was classified as popular.
We found that typedoc-plugin-markdown demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
NIST updates on the NVD backlog after media reports that over 50% of KEVs were unenriched since mid-February. They've contracted additional support and partnered with CISA to clear the backlog by fiscal year-end.
Security News
A hospital in Mobile, Alabama, agreed to a settlement in a landmark ransomware death lawsuit, but is now reportedly reconsidering the agreement and refusing to pay.
Security News
A new report explores how advancements in LLMs are enhancing cyber threats, including polymorphic malware, personalized spearphishing, and the risk of hijacking customer service bots.