quartz/docs/plugins/Frontmatter.md

title	tags
Frontmatter	plugin/transformer

This plugin parses the frontmatter of the page using the gray-matter library. See authoring content#Syntax, Obsidian compatibility and OxHugo compatibility for more information.

Note

For information on how to add, remove or configure plugins, see the configuration#Plugins page.

This plugin accepts the following configuration options:

• 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 "---".
• language: the language to use for parsing the frontmatter. Can be yaml (default) or toml.

Warning

This plugin must not be removed, otherwise Quartz will break.

List

Quartz supports the following frontmatter:

• title
  • title
• description
  • description
• permalink
  • permalink
• comments
  • comments
• lang
  • lang
• publish
  • publish
• draft
  • draft
• enableToc
  • enableToc
• tags
  • tags
  • tag
• aliases
  • aliases
  • alias
• cssclasses
  • cssclasses
  • cssclass
• socialDescription
  • socialDescription
• socialImage
  • socialImage
  • image
  • cover
• created
  • created
  • date
• modified
  • modified
  • lastmod
  • updated
  • last-modified
• published
  • published
  • publishDate
  • date
• encrypt
  • encrypt
  • encrypted
• encryptConfig
  • Overrides for the plugins/Encrypt
• password
  • password

API

• Category: Transformer
• Function name: Plugin.Frontmatter().
• Source: quartz/plugins/transformers/frontmatter.ts.