RoadmapShopEvents
Skip to main content

Home > @microsoft/api-documenter > IMarkdownDocumenterFeatureOnBeforeWritePageArgs

IMarkdownDocumenterFeatureOnBeforeWritePageArgs interface

Event arguments for MarkdownDocumenterFeature.onBeforeWritePage()

Signature:

export interface IMarkdownDocumenterFeatureOnBeforeWritePageArgs 

Properties

PropertyModifiersTypeDescription
apiItemreadonlyApiItemThe API item corresponding to this page.
outputFilenamereadonlystringThe filename where the output will be written.
pageContentstringThe page content. The MarkdownDocumenterFeature.onBeforeWritePage() handler can reassign this string to customize the page appearance.