From 0d3cf2922618774fc397dca8cb92fcf76fb0db02 Mon Sep 17 00:00:00 2001
From: Ben Schlegel <31989404+benschlegel@users.noreply.github.com>
Date: Mon, 18 Sep 2023 21:32:00 +0000
Subject: [PATCH] docs: fix explorer example (#483)
---
quartz/plugins/transformers/gfm.ts | 52 ++++++++++++++++++++++++++++++++++------------------
1 files changed, 34 insertions(+), 18 deletions(-)
diff --git a/quartz/plugins/transformers/gfm.ts b/quartz/plugins/transformers/gfm.ts
index ef3a944..62624aa 100644
--- a/quartz/plugins/transformers/gfm.ts
+++ b/quartz/plugins/transformers/gfm.ts
@@ -1,30 +1,46 @@
-import { PluggableList } from "unified"
import remarkGfm from "remark-gfm"
-import smartypants from 'remark-smartypants'
+import smartypants from "remark-smartypants"
import { QuartzTransformerPlugin } from "../types"
+import rehypeSlug from "rehype-slug"
+import rehypeAutolinkHeadings from "rehype-autolink-headings"
export interface Options {
enableSmartyPants: boolean
+ linkHeadings: boolean
}
const defaultOptions: Options = {
- enableSmartyPants: true
+ enableSmartyPants: true,
+ linkHeadings: true,
}
-export class GitHubFlavoredMarkdown extends QuartzTransformerPlugin {
- name = "GitHubFlavoredMarkdown"
- opts: Options
-
- constructor(opts?: Options) {
- super()
- this.opts = { ...defaultOptions, ...opts }
- }
-
- markdownPlugins(): PluggableList {
- return this.opts.enableSmartyPants ? [remarkGfm] : [remarkGfm, smartypants]
- }
-
- htmlPlugins(): PluggableList {
- return []
+export const GitHubFlavoredMarkdown: QuartzTransformerPlugin<Partial<Options> | undefined> = (
+ userOpts,
+) => {
+ const opts = { ...defaultOptions, ...userOpts }
+ return {
+ name: "GitHubFlavoredMarkdown",
+ markdownPlugins() {
+ return opts.enableSmartyPants ? [remarkGfm, smartypants] : [remarkGfm]
+ },
+ htmlPlugins() {
+ if (opts.linkHeadings) {
+ return [
+ rehypeSlug,
+ [
+ rehypeAutolinkHeadings,
+ {
+ behavior: "append",
+ content: {
+ type: "text",
+ value: " ยง",
+ },
+ },
+ ],
+ ]
+ } else {
+ return []
+ }
+ },
}
}
--
Gitblit v1.10.0