UNPKG

@microsoft/api-documenter

Version:

Read JSON files from api-extractor, generate documentation pages

14 lines 749 B
import { type ApiModel, type ApiItem } from '@microsoft/api-extractor-model'; import type { IYamlTocFile } from '../yaml/IYamlTocFile'; import { YamlDocumenter } from './YamlDocumenter'; import type { DocumenterConfig } from './DocumenterConfig'; /** * EXPERIMENTAL - This documenter is a prototype of a new config file driven mode of operation for * API Documenter. It is not ready for general usage yet. Its design may change in the future. */ export declare class ExperimentalYamlDocumenter extends YamlDocumenter { #private; constructor(apiModel: ApiModel, documenterConfig: DocumenterConfig); protected buildYamlTocFile(apiItems: ReadonlyArray<ApiItem>): IYamlTocFile; } //# sourceMappingURL=ExperimentalYamlDocumenter.d.ts.map