# @microsoft/api-documenter

> Read JSON files from api-extractor, generate documentation pages

Latest version **7.30.14** (published 2026-09-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install @microsoft/api-documenter
pnpm add @microsoft/api-documenter
yarn add @microsoft/api-documenter
bun add @microsoft/api-documenter
```

## 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 | 7.30.14 |
| Published | 2026-09-09 |
| First published | 2017-08-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 6495 |
| Maintainers | microsoft1es, microsoft-oss-releases, odspnpm |

## Links

- npm: https://www.npmjs.com/package/@microsoft/api-documenter
- Repository: https://github.com/microsoft/rushstack
- Homepage: https://api-extractor.com/
- Issues: https://github.com/microsoft/rushstack/issues
- npm.io page: https://npm.io/package/@microsoft/api-documenter

## Recent versions

- 7.30.14 (latest) — 2026-09-09
- 7.28.5 (pr5496) — 2026-01-12
- 7.0.51 (beta) — 2019-04-12
- 7.30.13 — 2026-08-21
- 7.30.12 — 2026-08-20
- 7.30.11 — 2026-08-14
- 7.30.10 — 2026-07-21
- 7.30.9 — 2026-07-17
- 7.30.8 — 2026-07-16
- 7.30.7 — 2026-06-13
- 7.30.6 — 2026-06-08
- 7.30.5 — 2026-04-20
- 7.30.4 — 2026-04-20
- 7.30.3 — 2026-04-18
- 7.30.2 — 2026-04-18
- … 712 more at https://npm.io/package/@microsoft/api-documenter/versions

## README

# @microsoft/api-documenter

This tool can be used to generate an online API reference manual for your TypeScript library.
It reads the *.api.json data files produced by [API Extractor](https://api-extractor.com/),
and then generates files in [Markdown](https://en.wikipedia.org/wiki/Markdown) or
[DocFX](https://dotnet.github.io/docfx/) format.

For usage information, see the
[Generating Docs](https://api-extractor.com/pages/setup/generating_docs/) article from the API Extractor
documentation.

## Links

- [CHANGELOG.md](
  https://github.com/microsoft/rushstack/blob/main/apps/api-documenter/CHANGELOG.md) - Find
  out what's new in the latest version
- [API Reference](https://api.rushstack.io/pages/api-documenter/)

API Documenter is part of the [Rush Stack](https://rushstack.io/) family of projects.

---
_Source: https://npm.io/package/@microsoft/api-documenter · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._