roadmap/quartz/plugins/transformers/gfm.ts

38 lines
989 B
TypeScript
Raw Normal View History

2023-05-30 15:02:20 +00:00
import remarkGfm from "remark-gfm"
import smartypants from 'remark-smartypants'
import { QuartzTransformerPlugin } from "../types"
2023-06-01 23:48:38 +00:00
import rehypeSlug from "rehype-slug"
2023-06-04 16:35:45 +00:00
import rehypeAutolinkHeadings from "rehype-autolink-headings"
2023-05-30 15:02:20 +00:00
export interface Options {
enableSmartyPants: boolean
2023-06-01 23:48:38 +00:00
linkHeadings: boolean
2023-05-30 15:02:20 +00:00
}
const defaultOptions: Options = {
2023-06-01 23:48:38 +00:00
enableSmartyPants: true,
linkHeadings: true
2023-05-30 15:02:20 +00:00
}
export const GitHubFlavoredMarkdown: QuartzTransformerPlugin<Partial<Options> | undefined> = (userOpts) => {
const opts = { ...defaultOptions, ...userOpts }
return {
name: "GitHubFlavoredMarkdown",
markdownPlugins() {
2023-07-02 20:08:29 +00:00
return opts.enableSmartyPants ? [remarkGfm, smartypants] : [remarkGfm]
},
htmlPlugins() {
if (opts.linkHeadings) {
return [rehypeSlug, [rehypeAutolinkHeadings, {
behavior: 'append', content: {
type: 'text',
2023-07-02 20:08:29 +00:00
value: ' §',
}
}]]
} else {
return []
}
}
2023-05-30 15:02:20 +00:00
}
}