Rush StackShopBlogEvents
Skip to main content

Home > @microsoft/api-documenter > MarkdownDocumenterFeatureContext

MarkdownDocumenterFeatureContext class

Context object for MarkdownDocumenterFeature. Exposes various services that can be used by a plugin.

Signature:

export declare class MarkdownDocumenterFeatureContext 

Remarks

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the MarkdownDocumenterFeatureContext class.

Properties

Property

Modifiers

Type

Description

apiModel

readonly

ApiModel

Provides access to the ApiModel for the documentation being generated.

documenter

readonly

MarkdownDocumenterAccessor

Exposes functionality of the documenter.

outputFolder

readonly

string

The full path to the output folder.