V4 pre-release documentation 👋
Introduction

typedoc-plugin-markdown

npm

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

Overview

By default, TypeDoc will render API documentation as a webpage, e.g. HTML files. This plugin replaces the default HTML theme with a built-in Markdown theme and exposes some additional options.

Markdown output is useful when documentation is to be included in project README files, Wikis and static site generators.

Features

Examples