@microsoft/api-documenter
Advanced tools
Read JSON files from api-extractor, generate documentation pages
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.
FAQs
Read JSON files from api-extractor, generate documentation pages
The npm package @microsoft/api-documenter receives a total of 110,196 weekly downloads. As such, @microsoft/api-documenter popularity was classified as popular.
We found that @microsoft/api-documenter demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
An emerging npm supply chain attack that infects repos, steals CI secrets, and targets developer AI toolchains for further compromise.
Company News
Socket is proud to join the OpenJS Foundation as a Silver Member, deepening our commitment to the long-term health and security of the JavaScript ecosystem.
Security News
npm now links to Socket's security analysis on every package page. Here's what you'll find when you click through.
