@microsoft/api-documenter

Read JSON files from api-extractor, generate documentation pages

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
@microsoft/api-documenter
Minified + gzip package size for @microsoft/api-documenter in KB

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.

Links

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

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.