more documentation

Jacky Zhao

2023-08-11 259d0a6d9ac5a02f0281e3fc061861b23481348f

 quartz/plugins/transformers/frontmatter.ts

@@ -1,51 +1,62 @@
import { PluggableList } from "unified"
import matter from "gray-matter"
import remarkFrontmatter from 'remark-frontmatter'
import remarkFrontmatter from "remark-frontmatter"
import { QuartzTransformerPlugin } from "../types"
import yaml from "js-yaml"
import { slugTag } from "../../path"

export interface Options {
  language: 'yaml' | 'toml',
  delims: string | string[]
}

const defaultOptions: Options = {
  language: 'yaml',
  delims: '---'
  delims: "---",
}

export class FrontMatter extends QuartzTransformerPlugin {
  name = "FrontMatter"
  opts: Options
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,
              engines: {
                yaml: (s) => yaml.load(s, { schema: yaml.JSON_SCHEMA }) as object,
              },
            })

  constructor(opts?: Partial<Options>) {
    super()
    this.opts = { ...defaultOptions, ...opts }
  }
            // tag is an alias for tags
            if (data.tag) {
              data.tags = data.tag
            }

  markdownPlugins(): PluggableList {
    return [
      remarkFrontmatter,
      () => {
        return (_, file) => {
          const { data } = matter(file.value, this.opts)
            if (data.tags && !Array.isArray(data.tags)) {
              data.tags = data.tags
                .toString()
                .split(",")
                .map((tag: string) => tag.trim())
            }

          // fill in frontmatter
          file.data.frontmatter = {
            title: file.stem ?? "Untitled",
            tags: [],
            ...data
            // slug them all!!
            data.tags = data.tags?.map((tag: string) => slugTag(tag)) ?? []

            // fill in frontmatter
            file.data.frontmatter = {
              title: file.stem ?? "Untitled",
              tags: [],
              ...data,
            }
          }
        }
      }
    ]
  }

  htmlPlugins(): PluggableList {
    return []
        },
      ]
    },
  }
}

declare module 'vfile' {
declare module "vfile" {
  interface DataMap {
    frontmatter: { [key: string]: any } & {
      title: string