Home > @microsoft/api-documenter > MarkdownDocumenterFeature
MarkdownDocumenterFeature class
Inherit from this base class to implement an API Documenter plugin feature that customizes the generation of markdown output.
Signature:
export declare class MarkdownDocumenterFeature extends PluginFeature
Extends: PluginFeature
Properties
Property | Modifiers | Type | Description |
---|---|---|---|
context | MarkdownDocumenterFeatureContext | Exposes various services that can be used by a plugin. |
Methods
Method | Modifiers | Description |
---|---|---|
[Symbol.hasInstance](instance) | static | |
onBeforeWritePage(eventArgs) | This event occurs before each markdown file is written. It provides an opportunity to customize the content of the file. | |
onFinished(eventArgs) | This event occurs after all output files have been written. |