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

42 lines
1.0 KiB
TypeScript
Raw Normal View History

2023-05-30 15:02:20 +00:00
import { PluggableList } from "unified"
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 class GitHubFlavoredMarkdown extends QuartzTransformerPlugin {
name = "GitHubFlavoredMarkdown"
opts: Options
2023-06-10 06:06:02 +00:00
constructor(opts?: Partial<Options>) {
2023-05-30 15:02:20 +00:00
super()
this.opts = { ...defaultOptions, ...opts }
}
markdownPlugins(): PluggableList {
return this.opts.enableSmartyPants ? [remarkGfm] : [remarkGfm, smartypants]
}
htmlPlugins(): PluggableList {
2023-06-01 23:48:38 +00:00
return this.opts.linkHeadings
? [rehypeSlug, [rehypeAutolinkHeadings, {
behavior: 'append', content: {
type: 'text',
2023-06-06 05:14:17 +00:00
value: ' §'
2023-06-01 23:48:38 +00:00
}
}]]
: []
2023-05-30 15:02:20 +00:00
}
}