quartz-research-note/quartz/plugins/transformers/toc.ts

70 lines
1.8 KiB
TypeScript
Raw Normal View History

2023-06-10 06:06:02 +00:00
import { QuartzTransformerPlugin } from "../types"
import { Root } from "mdast"
import { visit } from "unist-util-visit"
import { toString } from "mdast-util-to-string"
2023-07-23 00:27:41 +00:00
import { slug as slugAnchor } from "github-slugger"
2023-06-10 06:06:02 +00:00
export interface Options {
2023-07-23 00:27:41 +00:00
maxDepth: 1 | 2 | 3 | 4 | 5 | 6
minEntries: 1
2023-06-10 06:06:02 +00:00
showByDefault: boolean
}
const defaultOptions: Options = {
maxDepth: 3,
minEntries: 1,
showByDefault: true,
}
interface TocEntry {
2023-07-23 00:27:41 +00:00
depth: number
text: string
slug: string // this is just the anchor (#some-slug), not the canonical slug
2023-06-10 06:06:02 +00:00
}
2023-07-23 00:27:41 +00:00
export const TableOfContents: QuartzTransformerPlugin<Partial<Options> | undefined> = (
userOpts,
) => {
const opts = { ...defaultOptions, ...userOpts }
return {
name: "TableOfContents",
markdownPlugins() {
2023-07-23 00:27:41 +00:00
return [
() => {
return async (tree: Root, file) => {
const display = file.data.frontmatter?.enableToc ?? opts.showByDefault
if (display) {
const toc: TocEntry[] = []
let highestDepth: number = opts.maxDepth
visit(tree, "heading", (node) => {
if (node.depth <= opts.maxDepth) {
const text = toString(node)
highestDepth = Math.min(highestDepth, node.depth)
toc.push({
depth: node.depth,
text,
slug: slugAnchor(text),
})
}
})
2023-06-10 06:06:02 +00:00
2023-07-23 00:27:41 +00:00
if (toc.length > opts.minEntries) {
file.data.toc = toc.map((entry) => ({
...entry,
depth: entry.depth - highestDepth,
}))
}
2023-06-10 06:06:02 +00:00
}
}
2023-07-23 00:27:41 +00:00
},
]
},
2023-06-10 06:06:02 +00:00
}
}
2023-07-23 00:27:41 +00:00
declare module "vfile" {
2023-06-10 06:06:02 +00:00
interface DataMap {
toc: TocEntry[]
}
}