From c538c151c7462ad0395ff2c15c5e11e89e362aa8 Mon Sep 17 00:00:00 2001
From: Striven <sg.striven@cutecat.club>
Date: Sat, 04 Apr 2026 19:47:16 +0000
Subject: [PATCH] Initial commit
---
quartz/plugins/transformers/toc.ts | 89 ++++++++++++++++++++++----------------------
1 files changed, 45 insertions(+), 44 deletions(-)
diff --git a/quartz/plugins/transformers/toc.ts b/quartz/plugins/transformers/toc.ts
index 863e3a1..791547b 100644
--- a/quartz/plugins/transformers/toc.ts
+++ b/quartz/plugins/transformers/toc.ts
@@ -1,72 +1,73 @@
-import { PluggableList } from "unified"
import { QuartzTransformerPlugin } from "../types"
import { Root } from "mdast"
import { visit } from "unist-util-visit"
import { toString } from "mdast-util-to-string"
-import { slugAnchor } from "../../path"
+import Slugger from "github-slugger"
export interface Options {
- maxDepth: 1 | 2 | 3 | 4 | 5 | 6,
- minEntries: 1,
+ maxDepth: 1 | 2 | 3 | 4 | 5 | 6
+ minEntries: number
showByDefault: boolean
+ collapseByDefault: boolean
}
const defaultOptions: Options = {
maxDepth: 3,
minEntries: 1,
showByDefault: true,
+ collapseByDefault: false,
}
interface TocEntry {
- depth: number,
- text: string,
- slug: string
+ depth: number
+ text: string
+ slug: string // this is just the anchor (#some-slug), not the canonical slug
}
-export class TableOfContents extends QuartzTransformerPlugin {
- name = "TableOfContents"
- opts: Options
-
- constructor(opts?: Partial<Options>) {
- super()
- this.opts = { ...defaultOptions, ...opts }
- }
-
- markdownPlugins(): PluggableList {
- return [() => {
- return async (tree: Root, file) => {
- const display = file.data.frontmatter?.enableToc ?? this.opts.showByDefault
- if (display) {
- const toc: TocEntry[] = []
- let highestDepth: number = this.opts.maxDepth
- visit(tree, 'heading', (node) => {
- if (node.depth <= this.opts.maxDepth) {
- const text = toString(node)
- highestDepth = Math.min(highestDepth, node.depth)
- toc.push({
- depth: node.depth,
- text,
- slug: slugAnchor.slug(text)
+const slugAnchor = new Slugger()
+export const TableOfContents: QuartzTransformerPlugin<Partial<Options>> = (userOpts) => {
+ const opts = { ...defaultOptions, ...userOpts }
+ return {
+ name: "TableOfContents",
+ markdownPlugins() {
+ return [
+ () => {
+ 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)
+ highestDepth = Math.min(highestDepth, node.depth)
+ toc.push({
+ depth: node.depth,
+ text,
+ slug: slugAnchor.slug(text),
+ })
+ }
})
+
+ if (toc.length > 0 && toc.length > opts.minEntries) {
+ file.data.toc = toc.map((entry) => ({
+ ...entry,
+ depth: entry.depth - highestDepth,
+ }))
+ file.data.collapseToc = opts.collapseByDefault
+ }
}
- })
-
- if (toc.length > this.opts.minEntries) {
- file.data.toc = toc.map(entry => ({ ...entry, depth: entry.depth - highestDepth }))
}
- }
- }
- }]
- }
-
- htmlPlugins(): PluggableList {
- return []
+ },
+ ]
+ },
}
}
-declare module 'vfile' {
+declare module "vfile" {
interface DataMap {
toc: TocEntry[]
+ collapseToc: boolean
}
}
-
--
Gitblit v1.10.0