Skip to content

Latest commit

 

History

History
20 lines (13 loc) · 878 Bytes

index.mdx

File metadata and controls

20 lines (13 loc) · 878 Bytes
Raw

import { Cards, Callout } from 'nextra/components'; import pjson from '../../../packages/typedoc-plugin-markdown/package.json';

typedoc-plugin-markdown

Overview

By default TypeDoc will output API documentation as HTML.

This plugin enables TypeDoc to output documentation in Markdown. 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.