Quartz's default note properties plugin.
  • TypeScript 94.4%
  • SCSS 5.6%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2026-11-09 23:03:38 +01:00
.changeset chore: version package 2026-11-09 04:06:30 +00:00
.github/workflows ci: run ci.yml on the changesets version PR and report it as a commit status 2026-11-08 19:10:53 +01:00
src fix: refuse JavaScript frontmatter instead of executing it (#4) 2026-11-08 17:49:08 +01:00
test fix: refuse JavaScript frontmatter instead of executing it (#4) 2026-11-08 17:49:08 +01:00
types chore: centralize type declarations and standardize tooling config 2026-03-16 18:55:26 +01:00
.eslintrc.json chore: centralize type declarations and standardize tooling config 2026-03-16 18:55:26 +01:00
.gitignore chore: migrate to npm publishing 2026-07-23 09:07:20 +02:00
.prettierignore chore: centralize type declarations and standardize tooling config 2026-03-16 18:55:26 +01:00
.prettierrc Initial commit 2026-02-22 15:03:10 +01:00
CHANGELOG.md chore: version package 2026-11-09 04:06:30 +00:00
LICENSE Initial commit 2026-02-22 15:03:10 +01:00
package-lock.json chore: version package 2026-11-09 04:06:30 +00:00
package.json chore: version package 2026-11-09 04:06:30 +00:00
README.md docs(readme): Quartz 5.1 — npm install and config, correct options and defaults 2026-11-09 22:57:49 +01:00
tsconfig.build.json fix: use separate tsconfig for DTS build to avoid vitest dependency 2026-03-22 13:12:01 +01:00
tsconfig.json Initial commit 2026-02-22 15:03:10 +01:00
tsup.config.ts build: keep preact and the other shared packages external (tsup's noExternal overrode them) 2026-11-09 04:49:30 +01:00
vitest.config.ts fix: remove template boilerplate test files and add passWithNoTests 2026-03-09 03:21:37 +01:00

@quartz-community/note-properties

Renders frontmatter properties as a visible properties view on the page, similar to Obsidian's properties panel.

Note

Quartz 5.1+ parses frontmatter itself (built-in, configured under configuration.frontmatter). On those versions this plugin only builds and renders the properties view; disabling it no longer breaks titles, tags, aliases or drafts. On older Quartz versions it still parses frontmatter as before.

Installation

npx quartz plugin add @quartz-community/note-properties

Usage

This plugin serves as both a transformer (collecting the properties to show, resolving links in them) and a component (displaying the properties view). One entry configures both: options applies to the transformer and the component, layout places the component. It is already enabled in the default quartz.config.yaml:

plugins:
  - 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

Configuration

Option Type Default Description
includeAll boolean false Whether to include all frontmatter properties.
includedProperties string[] ["description", "tags", "aliases"] Properties to include when includeAll is false.
excludedProperties string[] [] Properties to always exclude, whether they come from includeAll or includedProperties.
hidePropertiesView boolean false Hide the properties view by default (it can still be shown per note). To never show it, disable the plugin; frontmatter is parsed either way.
collapsed boolean false Start the properties view collapsed (it can still be expanded, and set per note).
delimiters string | [string, string] "---" Quartz < 5.1 only: frontmatter delimiters. On 5.1+ set configuration.frontmatter.delimiters.
language "yaml" | "toml" "yaml" Quartz < 5.1 only: frontmatter language. On 5.1+ set configuration.frontmatter.language.

On Quartz 5.1+, delimiters and language left on this plugin are still applied; npx quartz plugin doctor --fix moves them to configuration.frontmatter.

Per-note overrides

  • quartz-properties (or quartzProperties): true force-shows the view, false force-hides it, overriding hidePropertiesView.
  • quartz-properties-collapse (or quartzPropertiesCollapse): true starts the view collapsed, false expanded, overriding collapsed.

These keys are left out of the properties table.

Documentation

See the Quartz documentation and its properties panel section for more information.

License

MIT