# typedoc-plugin-markdown

> A TypeDoc plugin that generates TypeScript API documentation as Markdown.

Latest version **4.13.0** (published 2026-08-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install typedoc-plugin-markdown
pnpm add typedoc-plugin-markdown
yarn add typedoc-plugin-markdown
bun add typedoc-plugin-markdown
```

## Health

**Score 55/100 (C)** — status: active.

Positive: no vulnerabilities; recently updated; high maintenance score.

Warnings: low downloads; no types; no esm support.

## Facts

| | |
|---|---|
| Version | 4.13.0 |
| Published | 2026-08-25 |
| First published | 2017-06-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 821 |
| Author | Thomas Grey |
| Maintainers | tgreyuk |
| Keywords | documentation, markdown, typedoc, typescript, typedoc-plugin, typedoc-theme, api-documentation, documentation-generator, docs-generator, markdown-generator |

## Links

- npm: https://www.npmjs.com/package/typedoc-plugin-markdown
- Repository: https://github.com/typedoc2md/typedoc-plugin-markdown
- Homepage: https://typedoc-plugin-markdown.org
- Issues: https://github.com/typedoc2md/typedoc-plugin-markdown/issues
- npm.io page: https://npm.io/package/typedoc-plugin-markdown

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 4.13.0 (latest) — 2026-08-25
- 4.12.0 — 2026-06-02
- 4.11.0 — 2026-03-18
- 4.10.0 — 2026-02-06
- 4.9.0 — 2025-09-19
- 4.8.1 — 2025-08-11
- 4.8.0 — 2025-07-29
- 4.7.1 — 2025-07-19
- 4.7.0 — 2025-06-20
- 4.6.4 — 2025-06-01
- 4.6.3 — 2025-04-23
- 4.6.2 — 2025-04-09
- 4.6.1 — 2025-04-02
- 4.6.0 — 2025-03-23
- 4.5.2 — 2025-03-19
- … 255 more at https://npm.io/package/typedoc-plugin-markdown/versions

## README

# typedoc-plugin-markdown

[![npm](https://img.shields.io/npm/v/typedoc-plugin-markdown.svg?logo=npm)](https://www.npmjs.com/package/typedoc-plugin-markdown) [![Downloads](https://img.shields.io/npm/dw/typedoc-plugin-markdown?label=downloads)](https://www.npmjs.com/package/typedoc-plugin-markdown) [![Build Status](https://github.com/typedoc2md/typedoc-plugin-markdown/actions/workflows/ci.yml/badge.svg?branch=main&style=flat-square)](https://github.com/typedoc2md/typedoc-plugin-markdown/actions/workflows/ci.yml)

## Overview

[TypeDoc](https://typedoc.org) generates API documentation for TypeScript projects as HTML by default. This plugin adds Markdown output that can be easily integrated into different ecosystems, such as code repositories, wikis, and static site generators.

## Installation

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

## Features

- Generates CommonMark, GFM, and MDX-compatible Markdown from TypeDoc projects.
- Works alongside other TypeDoc plugins.
- Configurable output structure.
- Companion plugins for frontmatter and remark transforms.
- Companion themes for Docusaurus, VitePress, GitHub Wiki, and GitLab Wiki workflows.

## Documentation

See the [documentation](https://typedoc-plugin-markdown.org/docs) for installation, configuration options, and usage guides.

## Examples

See the [examples repository](https://github.com/typedoc2md/typedoc-plugin-markdown-examples) for generated output and publishing examples.

## License

MIT

---
_Source: https://npm.io/package/typedoc-plugin-markdown · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._