Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
bin
config Move api-documenter/api-extractor under "apps" category folder Oct 26, 2017
src Fix an issue where markdown documentation was not generated for the p… Jan 30, 2019
.npmignore Fix npmignore Oct 3, 2018
CHANGELOG.json Deleting change files and updating change logs for package updates. Feb 18, 2019
CHANGELOG.md Deleting change files and updating change logs for package updates. Feb 18, 2019
LICENSE Move api-documenter/api-extractor under "apps" category folder Oct 26, 2017
README.md Eliminate wiki links Dec 14, 2018
ad.cmd
gulpfile.js
package.json Applying package updates. Feb 18, 2019
run.cmd Move api-documenter/api-extractor under "apps" category folder Oct 26, 2017
tsconfig.json
tslint.json Updating projects to build with TS 3.2 Feb 11, 2019

README.md

@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 Generating Docs article from the API Extractor documentation.