typedoc-plugin-markdown

What is typedoc-plugin-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.

What are typedoc-plugin-markdown's main functionalities?

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'
};

Other packages similar to typedoc-plugin-markdown

typedoc

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.

documentation

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

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.

README

typedoc-plugin-markdown

A plugin for TypeDoc that enables TypeScript API documentation to be generated in Markdown.

What it does?

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.

Installation

npm install --save-dev typedoc typedoc-plugin-markdown

Usage

$ npx typedoc --plugin typedoc-plugin-markdown [args]

Note:

• The --plugin arg is optional - if omitted all installed plugins will run.
• If using with the default HTML theme or other themes, use --plugin none to switch the plugin off.
• The plugin needs to be executed from the same location as typedoc. Either run as an npm script or make sure to run npx typedoc.

Arguments

The following arguments can be used in addition to the default TypeDoc arguments.

• --theme <markdown|docusaurus|docusaurus2|vuepress|bitbucket|path/to/theme>
  Specify the theme that should be used. Defaults to markdown. Please read Markdown Themes for further details.
• --namedAnchors
  Use HTML named anchors as fragment identifiers for engines that do not automatically assign header ids.
• --hideSources
  Do not print source file link rendering.
• --hideBreadcrumbs
  Do not print breadcrumbs.

License

MIT