Home > @microsoft/api-documenter
api-documenter package
API Documenter generates an API reference website from the .api.json files created by API Extractor. The @microsoft/api-documenter package provides the command-line tool. It also exposes a developer API that you can use to create plugins that customize how API Documenter generates documentation.
Classes
| Class | Description |
|---|---|
| MarkdownDocumenterAccessor | Provides access to the documenter that is generating the output. |
| MarkdownDocumenterFeature | Inherit from this base class to implement an API Documenter plugin feature that customizes the generation of markdown output. |
| MarkdownDocumenterFeatureContext | Context object for MarkdownDocumenterFeature. Exposes various services that can be used by a plugin. |
| PluginFeatureContext | Context object for PluginFeature. Exposes various services that can be used by a plugin. |
| PluginFeatureInitialization | This is an internal part of the plugin infrastructure. |
Abstract Classes
| Abstract Class | Description |
|---|---|
| PluginFeature | The abstract base class for all API Documenter plugin features. |
Interfaces
| Interface | Description |
|---|---|
| IApiDocumenterPluginManifest | The manifest for an API Documenter plugin. |
| IFeatureDefinition | Defines a "feature" that is provided by an API Documenter plugin. A feature is a user-defined module that customizes the behavior of API Documenter. |
| IMarkdownDocumenterFeatureOnBeforeWritePageArgs | Event arguments for MarkdownDocumenterFeature.onBeforeWritePage() |
| IMarkdownDocumenterFeatureOnFinishedArgs | Event arguments for MarkdownDocumenterFeature.onFinished() |