Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@microsoft/api-documenter

microsoft802.7kMIT7.26.31TypeScript support: included

Read JSON files from api-extractor, generate documentation pages

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, and then generates files in Markdown or DocFX format.

For usage information, see the Generating Docs article from the API Extractor documentation.

API Documenter is part of the Rush Stack family of projects.