docs + various polish

Jacky Zhao

2023-07-10 08f8e3b4a4879dd7c91c16fbce80c4f2bc5e357f

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
import matter from "gray-matter"
import remarkFrontmatter from 'remark-frontmatter'
import { QuartzTransformerPlugin } from "../types"
import yaml from 'js-yaml'
import { slug as slugAnchor } from 'github-slugger'
 
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,
              engines: {
                yaml: s => yaml.load(s, { schema: yaml.JSON_SCHEMA }) as object
              }
            })
 
            // tag is an alias for tags
            if (data.tag) {
              data.tags = data.tag
            }
 
            if (data.tags && !Array.isArray(data.tags)) {
              data.tags = data.tags.toString().split(",").map((tag: string) => tag.trim())
            }
 
            // slug them all!!
            data.tags = data.tags?.map((tag: string) => slugAnchor(tag)) ?? []
 
            // 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[]
    }
  }
}