| | |
| | | |
| | | export interface Options { |
| | | maxDepth: 1 | 2 | 3 | 4 | 5 | 6 |
| | | minEntries: 1 |
| | | minEntries: number |
| | | showByDefault: boolean |
| | | collapseByDefault: boolean |
| | | } |
| | |
| | | slug: string // this is just the anchor (#some-slug), not the canonical slug |
| | | } |
| | | |
| | | export const TableOfContents: QuartzTransformerPlugin<Partial<Options> | undefined> = ( |
| | | userOpts, |
| | | ) => { |
| | | const slugAnchor = new Slugger() |
| | | export const TableOfContents: QuartzTransformerPlugin<Partial<Options>> = (userOpts) => { |
| | | const opts = { ...defaultOptions, ...userOpts } |
| | | return { |
| | | name: "TableOfContents", |
| | |
| | | return async (tree: Root, file) => { |
| | | const display = file.data.frontmatter?.enableToc ?? opts.showByDefault |
| | | if (display) { |
| | | const slugAnchor = new Slugger() |
| | | slugAnchor.reset() |
| | | const toc: TocEntry[] = [] |
| | | let highestDepth: number = opts.maxDepth |
| | | visit(tree, "heading", (node) => { |
| | |
| | | } |
| | | }) |
| | | |
| | | if (toc.length > opts.minEntries) { |
| | | if (toc.length > 0 && toc.length > opts.minEntries) { |
| | | file.data.toc = toc.map((entry) => ({ |
| | | ...entry, |
| | | depth: entry.depth - highestDepth, |