| | |
| | | import { Root } from "mdast" |
| | | import { visit } from "unist-util-visit" |
| | | import { toString } from "mdast-util-to-string" |
| | | import { slug as slugAnchor } from "github-slugger" |
| | | import Slugger from "github-slugger" |
| | | import { wikilinkRegex } from "./ofm" |
| | | |
| | | export interface Options { |
| | | maxDepth: 1 | 2 | 3 | 4 | 5 | 6 |
| | | minEntries: 1 |
| | | showByDefault: boolean |
| | | collapseByDefault: boolean |
| | | } |
| | | |
| | | const defaultOptions: Options = { |
| | | maxDepth: 3, |
| | | minEntries: 1, |
| | | showByDefault: true, |
| | | collapseByDefault: false, |
| | | } |
| | | |
| | | interface TocEntry { |
| | |
| | | slug: string // this is just the anchor (#some-slug), not the canonical slug |
| | | } |
| | | |
| | | const regexMdLinks = new RegExp(/\[([^\[]+)\](\(.*\))/, "g") |
| | | const slugAnchor = new Slugger() |
| | | export const TableOfContents: QuartzTransformerPlugin<Partial<Options> | undefined> = ( |
| | | userOpts, |
| | | ) => { |
| | |
| | | return async (tree: Root, file) => { |
| | | const display = file.data.frontmatter?.enableToc ?? opts.showByDefault |
| | | if (display) { |
| | | slugAnchor.reset() |
| | | const toc: TocEntry[] = [] |
| | | let highestDepth: number = opts.maxDepth |
| | | visit(tree, "heading", (node) => { |
| | | if (node.depth <= opts.maxDepth) { |
| | | const text = toString(node) |
| | | let text = toString(node) |
| | | |
| | | // strip link formatting from toc entries |
| | | text = text.replace(wikilinkRegex, (_, rawFp, __, rawAlias) => { |
| | | const fp = rawFp?.trim() ?? "" |
| | | const alias = rawAlias?.slice(1).trim() |
| | | return alias ?? fp |
| | | }) |
| | | text = text.replace(regexMdLinks, "$1") |
| | | |
| | | highestDepth = Math.min(highestDepth, node.depth) |
| | | toc.push({ |
| | | depth: node.depth, |
| | | text, |
| | | slug: slugAnchor(text), |
| | | slug: slugAnchor.slug(text), |
| | | }) |
| | | } |
| | | }) |
| | |
| | | ...entry, |
| | | depth: entry.depth - highestDepth, |
| | | })) |
| | | file.data.collapseToc = opts.collapseByDefault |
| | | } |
| | | } |
| | | } |
| | |
| | | declare module "vfile" { |
| | | interface DataMap { |
| | | toc: TocEntry[] |
| | | collapseToc: boolean |
| | | } |
| | | } |