myst-cli/dist/utils/toc.d.ts

Command line tools for MyST

import type { Logger } from 'myst-cli-utils';
import type { ISession } from '../session/types.js';
export declare const TOC_FORMAT = "jb-book";
export declare const TOC_FORMAT_ARTICLE = "jb-article";
export type TOCOptions = {
    path?: string;
    filename?: string;
    ci?: boolean;
};
export type JupyterBookPart = {
    caption?: string;
    chapters?: JupyterBookChapter[];
};
export type JupyterBookChapter = {
    file?: string;
    url?: string;
    title?: string;
    glob?: string;
    sections?: JupyterBookChapter[];
};
export type TOC = {
    format: string;
    root: string;
    sections?: JupyterBookChapter[];
    chapters?: JupyterBookChapter[];
    parts?: JupyterBookPart[];
};
export declare const tocFile: (filename: string) => string;
export declare function readSphinxTOC(log: Logger, opts?: TOCOptions): TOC;
export declare function validateSphinxTOC(session: ISession, path: string): boolean;
//# sourceMappingURL=toc.d.ts.map