Docs
Introduction

typedoc-plugin-markdown

Version: 4.2.1

Overview

By default TypeDoc will output API documentation as HTML. This 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, Wikis and static site generators.

Features

  • CommonMark, GFM and MDX 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.