API packages

These NPM packages export developer APIs that are documented in the integrated API reference for all Rush Stack projects:

• @microsoft/api-extractor API docs

  This is used to invoke the API Extractor engine from a toolchain. An code sample is presented in the Invoking API Extractor tutorial.

• @microsoft/api-extractor-model API docs

  This is used to read the .api.json data model, for example to implement a custom documentation tool. The NPM page for this package shows a code sample.

• @microsoft/api-documenter API docs

  This used to create plugins that customize the output of the API Documenter tool. This is an experimental new feature. For a usage example, take a look at the repo-scripts/doc-plugin-rush-stack project, which adds Jekyll headers to API Documenter's markdown output. The repo-scripts/generate-api-docs project uses this plugin to generate the Rush Stack API reference. It is invoked by running the generate-api-docs.cmd script. The plugin is registered in the api-documenter.json config file. The api-documenter-template.json file template contains documentation for all the settings.