Frontmatter parsing is built into Quartz: every page’s frontmatter is parsed with gray-matter and normalised (see Supported frontmatter). Displaying properties on the page is done by the optional note-properties plugin (Properties panel). See authoring content > Syntax, Obsidian compatibility and OxHugo compatibility for more information.

Parsing (built-in)

Configure it under configuration.frontmatter in quartz.config.yaml:

  • 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.
  • enabled: set to false (or use the shorthand frontmatter: false) to turn parsing off — only useful when a plugin replaces it (see built-in processing > Replacing a built-in).
  • order: where parsing runs among the transformers. Defaults to 0 (first).
quartz.config.yaml
configuration:
  frontmatter:
    language: toml
    delimiters: "+++"

Warning

With ObsidianFlavoredMarkdown‘s default preset: "legacy", only YAML frontmatter between --- lines is recognized as frontmatter by the Markdown parser; any other block would show up in the page. For TOML (+++) or custom delimiters, also set preset: "strict" on ObsidianFlavoredMarkdown.

Frontmatter is data, never code: JavaScript frontmatter (---js, ---javascript) is refused with an error naming the file. Frontmatter that can’t be parsed (broken YAML, or a single value or list instead of key: value properties) is reported as a problem in that file, so fix the file and build again.

Note

These two options used to be set on the note-properties plugin. If they are still there, they are applied automatically; npx quartz plugin doctor --fix moves them.

Properties panel plugin (note-properties)

Note

For information on how to add, remove or configure plugins, see the Configuration page.

The note-properties plugin accepts the following configuration options:

  • includeAll: include all frontmatter properties in the properties panel. When false, only includedProperties are shown. Defaults to false.
  • includedProperties: properties to include when includeAll is false. Defaults to ["description", "tags", "aliases"].
  • excludedProperties: properties to always exclude from display, whether they come from includeAll or includedProperties. Defaults to [].
  • hidePropertiesView: hide the visual properties panel by default (it can still be shown per note, see Per-note overrides). Defaults to false. To never show it, disable the plugin — frontmatter is parsed either way.
  • collapsed: start the panel collapsed (it can still be expanded, and set per note). Defaults to false.

Default options

quartz.config.yaml
- source: "@quartz-community/note-properties"
  enabled: true
  options:
    includeAll: false
    includedProperties:
      - description
      - tags
      - aliases
    excludedProperties: []
    hidePropertiesView: false
  order: 5
  layout:
    position: beforeBody
    priority: 15
    display: all

Properties panel

When enabled, this plugin renders a collapsible “Properties” panel before the page body. The panel displays selected frontmatter fields in a table with automatic type rendering:

  • Strings are shown as plain text. wikilinks and markdown links within strings are rendered as clickable links. Wikilink targets are slugified the same way as body-content links (e.g. [[My Note]] resolves to my-note) and matching is case-insensitive to mirror Obsidian’s behavior, so [[MyNote]], [[mynote]], and [[MYNOTE]] all point to the same page.
  • Arrays are rendered as comma-separated lists.
  • Booleans are rendered as disabled checkboxes.
  • Numbers are rendered in a monospace font.
  • Objects are rendered as JSON in a code block.
  • Tags get special treatment: they are rendered as highlighted links that point to the corresponding tag page.
  • Null/undefined values are shown as an em-dash (—).

Per-note overrides

You can control the properties panel on a per-note basis using frontmatter keys:

  • quartz-properties (or quartzProperties): set to true to force-show the panel, or false to force-hide it, overriding the global hidePropertiesView setting.
  • quartz-properties-collapse (or quartzPropertiesCollapse): set to true to start the panel collapsed, or false to start it expanded, overriding the default collapse state.

These keys are automatically excluded from the visible properties table.

Example frontmatter
---
title: My Note
quartz-properties: true
quartz-properties-collapse: false
---

Supported frontmatter

Quartz supports the following frontmatter fields. Where multiple keys are listed, they are aliases — the first matching key is used.

FieldKeysDescription
TitletitlePage title. Falls back to filename if empty.
DescriptiondescriptionPage description for metadata and search.
Tagstags, tagCategorization tags. Slugified the same way as file paths: spaces become -, & becomes -and-, % becomes -percent, and tags are lowercased so that #MyTag and #mytag resolve to the same tag page (matching Obsidian).
Aliasesaliases, aliasAlternative names for the page, used for link resolution.
PermalinkpermalinkThe page’s address (Obsidian Publish): published at this path; its file path redirects there.
CSS classescssclasses, cssclassCSS classes applied to the page body.
Social imagesocialImage, image, coverImage used for social media previews.
Social descriptionsocialDescriptionDescription used specifically for social media previews.
Created datecreated, dateWhen the note was created.
Modified datemodified, lastmod, updated, last-modifiedWhen the note was last modified. Falls back to created if unset.
Published datepublished, publishDate, dateWhen the note was published.
PublishpublishWhether the note should be published.
DraftdraftWhether the note is a draft.
CommentscommentsWhether comments are enabled for the note.
LanguagelangLanguage code for the note.
Enable TOCenableTocWhether to show the table of contents.

API