JSPM

@microsoft/api-documenter

7.0.51
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 134062
  • Score
    100M100P100Q170634F
  • License MIT

Read JSON files from api-extractor, generate documentation pages

Package Exports

  • @microsoft/api-documenter/lib/cli/ApiDocumenterCommandLine
  • @microsoft/api-documenter/lib/cli/MarkdownAction.js
  • @microsoft/api-documenter/lib/start.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@microsoft/api-documenter) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

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 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.