Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
By Philipp Burckhardt - Oct 17, 2024
@microsoft/api-documenter
Advanced tools
@microsoft/api-documenter
Read JSON files from api-extractor, generate documentation pages
@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 web pages using the Markdown file format.
The api-documenter tool is part of Microsoft's production documentation pipeline. It is provided as a code sample to illustrate how to load and process the API JSON file format. If your requirements are simple, you can use this tool directly. For more advanced scenarios, developers are encouraged to fork the project and modify the source code. The implementation is intentionally kept simple and easy to understand. This is possible because most of processing is already performed upstream by API Extractor.
For more information, see the Rendering API docs wiki article.
FAQs
Read JSON files from api-extractor, generate documentation pages
The npm package @microsoft/api-documenter receives a total of 66,625 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 0 open source maintainers collaborating on the project.
Package last updated on 05 Jan 2018
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.
Related posts
Product
Enhancing Open-Source Compliance: Introducing Socket’s Advanced License Analysis
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
By Christopher Bailey - Oct 17, 2024
Product
Introducing Socket Optimize
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.
By John-David Dalton - Oct 16, 2024