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 beyaml(default) ortoml.enabled: set tofalse(or use the shorthandfrontmatter: 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 to0(first).
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 setpreset: "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 --fixmoves 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. Whenfalse, onlyincludedPropertiesare shown. Defaults tofalse.includedProperties: properties to include whenincludeAllisfalse. Defaults to["description", "tags", "aliases"].excludedProperties: properties to always exclude from display, whether they come fromincludeAllorincludedProperties. Defaults to[].hidePropertiesView: hide the visual properties panel by default (it can still be shown per note, see Per-note overrides). Defaults tofalse. 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 tofalse.
Default options
- 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: allProperties 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 tomy-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(orquartzProperties): set totrueto force-show the panel, orfalseto force-hide it, overriding the globalhidePropertiesViewsetting.quartz-properties-collapse(orquartzPropertiesCollapse): set totrueto start the panel collapsed, orfalseto start it expanded, overriding the default collapse state.
These keys are automatically excluded from the visible properties table.
---
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.
| Field | Keys | Description |
|---|---|---|
| Title | title | Page title. Falls back to filename if empty. |
| Description | description | Page description for metadata and search. |
| Tags | tags, tag | Categorization 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). |
| Aliases | aliases, alias | Alternative names for the page, used for link resolution. |
| Permalink | permalink | The page’s address (Obsidian Publish): published at this path; its file path redirects there. |
| CSS classes | cssclasses, cssclass | CSS classes applied to the page body. |
| Social image | socialImage, image, cover | Image used for social media previews. |
| Social description | socialDescription | Description used specifically for social media previews. |
| Created date | created, date | When the note was created. |
| Modified date | modified, lastmod, updated, last-modified | When the note was last modified. Falls back to created if unset. |
| Published date | published, publishDate, date | When the note was published. |
| Publish | publish | Whether the note should be published. |
| Draft | draft | Whether the note is a draft. |
| Comments | comments | Whether comments are enabled for the note. |
| Language | lang | Language code for the note. |
| Enable TOC | enableToc | Whether to show the table of contents. |
API
- Parsing: built-in transformer,
quartz/plugins/builtins/frontmatter.ts - Properties panel: Transformer, Component —
ExternalPlugin.NoteProperties(). - Source:
quartz-community/note-properties - Install:
npx quartz plugin add @quartz-community/note-properties(included in the default configuration)