@canalplus/readme.doc/build/parse_doc_configs.d.ts

Readme's an Extremely Accessible Documentation MakEr

export interface VersionCategory {
    type: "version";
    link: string | undefined;
}
export interface ExternalLinkCategory {
    type: "external-link";
    link: string;
    displayName: string;
}
export interface GithubLinkCategory {
    type: "github-link";
    link: string;
}
export interface SearchCategory {
    type: "search";
}
export interface LocalDocCategory {
    type: "local-doc";
    displayName: string;
    firstPage: string | undefined;
    pages: Array<LocalDocPageInformation | LocalDocPageGroupInformation>;
}
export interface LocalDocPageInformation {
    isPageGroup: false;
    displayName: string;
    inputFile: string;
    outputFile: string;
}
export interface LocalDocPageGroupInformation {
    isPageGroup: true;
    displayName: string;
    pages: LocalDocPageInformation[];
    defaultOpen: boolean;
}
export interface LogoInformation {
    /** Optional link to redirect to when clicking on the logo. */
    link?: string | undefined;
    /** Optional URL to the image of the logo. */
    url?: string | undefined;
    /** Optional Path to the image of the logo. */
    srcPath?: string | undefined;
}
export type LinkCategory = VersionCategory | ExternalLinkCategory | GithubLinkCategory | SearchCategory | LocalDocCategory;
export interface ParsedDocConfig {
    logo: undefined | LogoInformation;
    favicon: undefined | {
        srcPath?: string | undefined;
    };
    links: LinkCategory[];
    linksRightIndex: number;
    siteMapRoot: undefined | string;
}
export default function parseDocConfigs(baseInDir: string, baseOutDir: string): Promise<ParsedDocConfig>;