UNPKG

@microsoft/api-documenter

Version:

Read JSON files from api-extractor, generate documentation pages

api-extractor.com

microsoft/rushstack

20 lines (14 loc) • 811 B
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
# @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.