@microsoft/api-documenter/lib/yaml/IYamlTocFile.d.ts

Read JSON files from api-extractor, generate documentation pages

/**
 * A node in the navigation hierarchy for the table of contents.
 */
export interface IYamlTocItem {
    /**
     * The title to display
     */
    name: string;
    /**
     * If specified, the hyperlink will point to the API with this UID
     */
    uid?: string;
    /**
     * IF specified, the hyperlink will point to this URL, which may be a relative URL path
     */
    href?: string;
    /**
     * Child nodes in the hierarchy
     */
    items?: IYamlTocItem[];
}
/**
 * TypeScript interface describing the toc.yml file format, used to represent
 * the table of contents for a Universal Reference YAML documentation file.
 */
export interface IYamlTocFile {
    items: IYamlTocItem[];
    metadata?: {
        [key: string]: string;
    };
}
//# sourceMappingURL=IYamlTocFile.d.ts.map