quartz-research-note/quartz/plugins/transformers/frontmatter.ts
2023-07-06 18:32:48 -07:00

51 lines
1.1 KiB
TypeScript

import matter from "gray-matter"
import remarkFrontmatter from 'remark-frontmatter'
import { QuartzTransformerPlugin } from "../types"
export interface Options {
language: 'yaml' | 'toml',
delims: string | string[]
}
const defaultOptions: Options = {
language: 'yaml',
delims: '---'
}
export const FrontMatter: QuartzTransformerPlugin<Partial<Options> | undefined> = (userOpts) => {
const opts = { ...defaultOptions, ...userOpts }
return {
name: "FrontMatter",
markdownPlugins() {
return [
remarkFrontmatter,
() => {
return (_, file) => {
const { data } = matter(file.value, opts)
if (typeof data.tags === 'string') {
data.tags = data.tags.split(" ")
}
// fill in frontmatter
file.data.frontmatter = {
title: file.stem ?? "Untitled",
tags: [],
...data
}
}
}
]
},
}
}
declare module 'vfile' {
interface DataMap {
frontmatter: { [key: string]: any } & {
title: string
tags: string[]
}
}
}