Read JSON files from api-extractor, generate documentation pages
Package: @microsoft/api-documenter
Created by: microsoft
Last modified: Wed, 10 Apr 2024 15:10:32 GMT
Version: 7.24.2
License: MIT
Downloads: 451,662
Repository: https://github.com/microsoft/rushstack
Install
npm install @microsoft/api-documenter
yarn add @microsoft/api-documenter
@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,
and then generates files in Markdown or
DocFX format.
For usage information, see the
Generating Docs article from the API Extractor
documentation.
Links
- CHANGELOG.md - Find
out what's new in the latest version - API Reference
API Documenter is part of the Rush Stack family of projects.
