Home > @microsoft/api-documenter > IMarkdownDocumenterFeatureOnBeforeWritePageArgs

IMarkdownDocumenterFeatureOnBeforeWritePageArgs interface

Event arguments for MarkdownDocumenterFeature.onBeforeWritePage()

Signature:

export interface IMarkdownDocumenterFeatureOnBeforeWritePageArgs 

Properties

Property Type Description
apiItem ApiItem The API item corresponding to this page.
outputFilename string The filename where the output will be written.
pageContent string The page content. The MarkdownDocumenterFeature.onBeforeWritePage() handler can reassign this string to customize the page appearance.