Home > @microsoft/api-documenter > MarkdownDocumenterFeature > onBeforeWritePage

MarkdownDocumenterFeature.onBeforeWritePage() method

This event occurs before each markdown file is written. It provides an opportunity to customize the content of the file.

Signature:

/** @virtual */
onBeforeWritePage(eventArgs: IMarkdownDocumenterFeatureOnBeforeWritePageArgs): void;

Parameters

Parameter Type Description
eventArgs IMarkdownDocumenterFeatureOnBeforeWritePageArgs  

Returns:

void