export type TocOptions = { /** * - Collapse toc in
pane */ collapse?: boolean; /** * - Text in expand pane */ collapseText?: string; /** * - Text to exclude from toc */ excludeText?: string; /** * - Exclude first heading from toc */ firsth1?: boolean; /** * - Mark as sub section table of contents */ sub?: boolean; /** * - Max depth of headings to add to toc. */ maxDepth?: number; }; export type TocAPI = { /** * - Toc generation options */ options: TocOptions; /** * - Markdown contents */ fileContent: string; /** * - Path to markdown file */ srcPath: string; /** * - Get block details for sub tables */ getBlockDetails: Function; }; /** * @typedef {object} TocOptions * @property {boolean} [collapse = false] - Collapse toc in
pane * @property {string} [collapseText] - Text in expand pane * @property {string} [excludeText] - Text to exclude from toc * @property {boolean} [firsth1 = true] - Exclude first heading from toc * @property {boolean} [sub = false] - Mark as sub section table of contents * @property {number} [maxDepth = 4] - Max depth of headings to add to toc. */ /** * @typedef {object} TocAPI * @property {TocOptions} options - Toc generation options * @property {string} fileContent - Markdown contents * @property {string} srcPath - Path to markdown file * @property {function} getBlockDetails - Get block details for sub tables */ /** * Generate a table of contents * @param {TocAPI} api * @returns */ export function odlGenerateToc({ options, fileContent, srcPath, getBlockDetails }: TocAPI): Promise; //# sourceMappingURL=toc.d.ts.map