typedoc-plugin-markdown
Advanced tools
A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.
The typedoc-plugin-markdown npm package is a plugin for TypeDoc that allows you to generate Markdown documentation from TypeScript projects. It extends TypeDoc's capabilities by providing support for various Markdown formats, making it easier to integrate with static site generators and other documentation tools.
Generate Markdown Documentation
This configuration file for TypeDoc uses the typedoc-plugin-markdown to generate Markdown documentation. The 'out' option specifies the output directory, and various 'exclude' options are used to filter out unnecessary parts of the documentation.
module.exports = {
plugins: ['typedoc-plugin-markdown'],
out: 'docs',
mode: 'file',
includeDeclarations: true,
excludeExternals: true,
excludePrivate: true,
excludeProtected: true,
excludeNotExported: true,
readme: 'none'
};Support for Custom Themes
This configuration demonstrates how to use a custom theme with the typedoc-plugin-markdown. The 'theme' option is set to 'custom-theme', which allows you to customize the look and feel of the generated Markdown documentation.
module.exports = {
plugins: ['typedoc-plugin-markdown'],
out: 'docs',
theme: 'custom-theme',
includeDeclarations: true,
excludeExternals: true,
excludePrivate: true,
excludeProtected: true,
excludeNotExported: true,
readme: 'none'
};Integration with Static Site Generators
This configuration shows how to set up the typedoc-plugin-markdown for integration with static site generators. The 'entryPoints' option specifies the entry points for the documentation, and 'entryPointStrategy' is set to 'expand' to include all relevant files.
module.exports = {
plugins: ['typedoc-plugin-markdown'],
out: 'docs',
mode: 'file',
includeDeclarations: true,
excludeExternals: true,
excludePrivate: true,
excludeProtected: true,
excludeNotExported: true,
readme: 'none',
entryPoints: ['src/index.ts'],
entryPointStrategy: 'expand'
};TypeDoc is a documentation generator for TypeScript projects. While it primarily generates HTML documentation, it can be extended with plugins like typedoc-plugin-markdown to support other formats. TypeDoc is the core tool that typedoc-plugin-markdown builds upon.
The documentation package is a documentation generator for JavaScript and TypeScript projects. It supports multiple output formats, including HTML and Markdown. Compared to typedoc-plugin-markdown, it offers a more general approach to documentation generation and is not specifically tailored for TypeScript.
JSDoc is a popular documentation generator for JavaScript projects. It can be used with TypeScript through type annotations and supports various output formats, including Markdown. While it is more commonly used for JavaScript, it can be adapted for TypeScript projects, making it a versatile alternative to typedoc-plugin-markdown.
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. MDX 2+ and GFM compliant.
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 TypeDoc plugin configuration option:
typedoc --plugin typedoc-plugin-markdown
For general TypeDoc configuration usage 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 several additional options. Please see Plugin Options for detailed usage.
Options that configure how files are generated.
Options that alter the format and structure of pages.
--hidePageHeader--hidePageTitle--hideBreadcrumbs--hideInPageTOC--indexPageTitle--memberPageTitle--excludeGroups--useCodeBlocks--expandObjects--parametersFormat--propertiesFormat--enumMembersFormat--typeDeclarationFormat--indexFormatOptions that configure additional functionality.
Contributions 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 138,717 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
Research
Socket researchers uncover how threat actors weaponize Out-of-Band Application Security Testing (OAST) techniques across the npm, PyPI, and RubyGems ecosystems to exfiltrate sensitive data.
Security News
Research
A malicious npm campaign is targeting Ethereum developers by impersonating Hardhat plugins and the Nomic Foundation, stealing sensitive data like private keys.
Research
Security News
Socket researchers uncover a malicious npm package posing as a tool for detecting vulnerabilities in Etherium smart contracts.