@microsoft/api-documenter
Version:
Read JSON files from api-extractor, generate documentation pages
17 lines • 585 B
TypeScript
import { type ApiModel } from '@microsoft/api-extractor-model';
import type { DocumenterConfig } from './DocumenterConfig';
export interface IMarkdownDocumenterOptions {
apiModel: ApiModel;
documenterConfig: DocumenterConfig | undefined;
outputFolder: string;
}
/**
* Renders API documentation in the Markdown file format.
* For more info: https://en.wikipedia.org/wiki/Markdown
*/
export declare class MarkdownDocumenter {
#private;
constructor(options: IMarkdownDocumenterOptions);
generateFiles(): void;
}
//# sourceMappingURL=MarkdownDocumenter.d.ts.map