JSPM

@microsoft/api-documenter

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

Read JSON files from api-extractor, generate documentation pages

Package Exports

  • @microsoft/api-documenter
  • @microsoft/api-documenter/bin/api-documenter
  • @microsoft/api-documenter/lib/cli/ApiDocumenterCommandLine
  • @microsoft/api-documenter/lib/cli/ApiDocumenterCommandLine.js
  • @microsoft/api-documenter/lib/cli/MarkdownAction.js
  • @microsoft/api-documenter/lib/documenters/MarkdownDocumenter
  • @microsoft/api-documenter/lib/documenters/MarkdownDocumenter.js
  • @microsoft/api-documenter/lib/index.js
  • @microsoft/api-documenter/lib/markdown/CustomMarkdownEmitter
  • @microsoft/api-documenter/lib/markdown/CustomMarkdownEmitter.js
  • @microsoft/api-documenter/lib/nodes/DocEmphasisSpan
  • @microsoft/api-documenter/lib/nodes/DocEmphasisSpan.js
  • @microsoft/api-documenter/lib/nodes/DocHeading
  • @microsoft/api-documenter/lib/nodes/DocHeading.js
  • @microsoft/api-documenter/lib/nodes/DocNoteBox
  • @microsoft/api-documenter/lib/nodes/DocNoteBox.js
  • @microsoft/api-documenter/lib/nodes/DocTable
  • @microsoft/api-documenter/lib/nodes/DocTable.js
  • @microsoft/api-documenter/lib/nodes/DocTableCell
  • @microsoft/api-documenter/lib/nodes/DocTableCell.js
  • @microsoft/api-documenter/lib/nodes/DocTableRow
  • @microsoft/api-documenter/lib/nodes/DocTableRow.js
  • @microsoft/api-documenter/lib/start
  • @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 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.