Frontmatter

overview:

• Parses page frontmatter via gray-matter.
• Displays selected properties in a collapsible panel.
• References: authoring content > Syntax, Obsidian compatibility, OxHugo compatibility.

Note

plugin_management:

• Configuration

Warning

required:

• Removing this plugin breaks Quartz.

Configuration

options:

• delimiters: frontmatter delimiters; one value (e.g. "---") or open/close pair (e.g. ["---", "~~~"]); default: "---".
• language: parser language; yaml or toml; default: yaml.
• includeAll: include every frontmatter property in the panel; when false, show only includedProperties; default: false.
• includedProperties: properties shown when includeAll is false; default: ["description", "tags", "aliases"].
• excludedProperties: properties never shown, including when includeAll is true; default: [].
• hidePropertiesView: hide the visual panel while preserving frontmatter processing; use for parser-only setups; default: false.

Default options

quartz.config.yaml

- source: github:quartz-community/note-properties
  enabled: true
  options:
    includeAll: false
    includedProperties:
      - description
      - tags
      - aliases
    excludedProperties: []
    hidePropertiesView: false
    delimiters: "---"
    language: yaml

Properties panel

panel:

• placement: before page body
• format: collapsible Properties table
• content: selected frontmatter fields
• type_rendering:
  • string: plain text; renders embedded wikilinks and markdown links as clickable links.
  • wikilink_targets: slugify like body-content links (e.g. [[My Note]] -> my-note).
  • wikilink_matching: case-insensitive to match Obsidian; [[MyNote]], [[mynote]], and [[MYNOTE]] resolve to the same page.
  • array: comma-separated list.
  • boolean: disabled checkbox.
  • number: monospace.
  • object: JSON code block.
  • tag: highlighted link to the corresponding tag page.
  • null_or_undefined: em dash (—).

Per-note overrides

frontmatter_overrides:

• quartz-properties, quartzProperties: true force-shows the panel; false force-hides it; overrides global hidePropertiesView.
• quartz-properties-collapse, quartzPropertiesCollapse: true starts collapsed; false starts expanded; overrides default collapse state.
• visibility: plugin excludes these keys from the visible properties table.

Example frontmatter

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

Supported frontmatter

supported_frontmatter:

• alias_precedence: first matching key wins.

Field	Keys	Description
Title	title	Page title; falls back to filename when empty.
Description	description	Page description for metadata and search.
Tags	tags, tag	Categorization tags; slugifies like file paths: spaces -> -, & -> -and-, % -> -percent; lowercases so #MyTag and #mytag resolve to the same tag page, matching Obsidian.
Aliases	aliases, alias	Alternative page names for link resolution.
Permalink	permalink	Custom URL slug; also adds an alias.
CSS classes	cssclasses, cssclass	CSS classes applied to the page body.
Social image	socialImage, image, cover	Image for social media previews.
Social description	socialDescription	Description for social media previews.
Created date	created, date	Note creation date.
Modified date	modified, lastmod, updated, last-modified	Last modification date; falls back to created when unset.
Published date	published, publishDate, date	Publication date.
Publish	publish	Controls publication.
Draft	draft	Marks the note as draft.
Comments	comments	Controls note comments.
Language	lang	Note language code.
Enable TOC	enableToc	Controls the table of contents.

API

api:

• category: Transformer, Component
• function: ExternalPlugin.NoteProperties()
• source: quartz-community/note-properties
• install: npx quartz plugin add github:quartz-community/note-properties