The Trans Directory
1---
2title: "Frontmatter"
3tags:
4 - plugin/transformer
5---
6
7This plugin parses the frontmatter of the page using the [gray-matter](https://github.com/jonschlinkert/gray-matter) library. See [[authoring content#Syntax]], [[Obsidian compatibility]] and [[OxHugo compatibility]] for more information.
8
9> [!note]
10> For information on how to add, remove or configure plugins, see the [[configuration#Plugins|Configuration]] page.
11
12This plugin accepts the following configuration options:
13
14- `delimiters`: the delimiters to use for the frontmatter. Can have one value (e.g. `"---"`) or separate values for opening and closing delimiters (e.g. `["---", "~~~"]`). Defaults to `"---"`.
15- `language`: the language to use for parsing the frontmatter. Can be `yaml` (default) or `toml`.
16
17> [!warning]
18> This plugin must not be removed, otherwise Quartz will break.
19
20## List
21
22Quartz supports the following frontmatter:
23
24- title
25 - `title`
26- description
27 - `description`
28- permalink
29 - `permalink`
30- comments
31 - `comments`
32- lang
33 - `lang`
34- publish
35 - `publish`
36- draft
37 - `draft`
38- enableToc
39 - `enableToc`
40- tags
41 - `tags`
42 - `tag`
43- aliases
44 - `aliases`
45 - `alias`
46- cssclasses
47 - `cssclasses`
48 - `cssclass`
49- socialDescription
50 - `socialDescription`
51- socialImage
52 - `socialImage`
53 - `image`
54 - `cover`
55- created
56 - `created`
57 - `date`
58- modified
59 - `modified`
60 - `lastmod`
61 - `updated`
62 - `last-modified`
63- published
64 - `published`
65 - `publishDate`
66 - `date`
67
68## API
69
70- Category: Transformer
71- Function name: `Plugin.Frontmatter()`.
72- Source: [`quartz/plugins/transformers/frontmatter.ts`](https://github.com/jackyzha0/quartz/blob/v4/quartz/plugins/transformers/frontmatter.ts).