Skip to content

Latest commit

 

History

History
36 lines (26 loc) · 1.38 KB

index.mdx

File metadata and controls

36 lines (26 loc) · 1.38 KB
Raw

import { Cards, Callout } from 'nextra/components'; import pjson from '../../../packages/typedoc-plugin-markdown/package.json'; import { FontAwesomeIcon } from '@fortawesome/react-fontawesome'; import { faGithub } from '@fortawesome/free-brands-svg-icons';

typedoc-plugin-markdown

Overview

By default TypeDoc will output API documentation as HTML. The plugin replaces the default HTML theme with a built-in Markdown theme and exposes some additional options.

Since many tools and platforms support Markdown, the documentation generated by this plugin can be easily integrated into different ecosystems, such as code repositories, static site generators or documentation hosting services.

Features

  • MDX and GFM compliant.
  • Works alongside other TypeDoc plugins.
  • Configurable output file structure.
  • Configurable UX options
  • Frontmatter and Remark utility plugins available.

Examples

Visit the dedicated examples repository of examples showcasing the output generated using the plugin.

} arrow={true} href="https://github.com/typedoc-plugin-markdown/typedoc-plugin-markdown-examples" target="_blank" />