quartz-community/note-properties
1
0
Fork 0
mirror of https://github.com/quartz-community/note-properties.git synced 2026-07-22 02:50:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
16 commits 1 branch 0 tags 456 KiB
TypeScript 93.1%
SCSS 6.9%
Find a file
saberzero1 2d29fc5c07
fix: add build-time deps for DTS generation 
Peer dependencies needed at build time for TypeScript declaration file
generation were missing from devDependencies. Without them, the DTS build
fails silently, producing no index.d.ts.
2026-03-14 22:26:14 +01:00
.github/workflows Initial commit 2026-02-22 15:03:10 +01:00
dist fix: add build-time deps for DTS generation 2026-03-14 22:26:14 +01:00
src feat: add render event listener for in-place DOM re-initialization 2026-03-12 19:45:35 +01:00
types fix: resolve ESLint and formatting issues for CI compliance 2026-03-09 03:47:02 +01:00
.eslintrc.json Initial commit 2026-02-22 15:03:10 +01:00
.gitignore chore: commit dist/ and remove prepare script 2026-03-14 22:00:25 +01:00
.prettierrc Initial commit 2026-02-22 15:03:10 +01:00
CHANGELOG.md Initial commit 2026-02-22 15:03:10 +01:00
LICENSE Initial commit 2026-02-22 15:03:10 +01:00
package-lock.json fix: add build-time deps for DTS generation 2026-03-14 22:26:14 +01:00
package.json fix: add build-time deps for DTS generation 2026-03-14 22:26:14 +01:00
README.md docs: update README for v5 unified config system 2026-02-25 16:07:03 +01:00
tsconfig.json Initial commit 2026-02-22 15:03:10 +01:00
tsup.config.ts fix: compile SCSS via sass instead of raw text to prevent lightningcss errors 2026-02-26 16:44:51 +01:00
vitest.config.ts fix: remove template boilerplate test files and add passWithNoTests 2026-03-09 03:21:37 +01:00

README.md

@quartz-community/note-properties

Parses frontmatter properties and renders them as a visible properties view on the page, similar to Obsidian's properties panel.

Installation

npx quartz plugin add github:quartz-community/note-properties

Usage

This plugin serves as both a transformer (parsing frontmatter) and a component (displaying the properties view).

plugins:
  # Transformer (parses frontmatter)
  - source: github:quartz-community/note-properties
    enabled: true
    options:
      includeAll: false
      includedProperties:
        - description
        - tags
        - aliases
      excludedProperties: []
      hidePropertiesView: false
      delimiters: "---"
      language: yaml

  # Component (displays properties in the page layout)
  - source: github:quartz-community/note-properties
    enabled: true
    layout:
      position: beforeBody
      priority: 15

For advanced use cases, you can override in TypeScript:

import * as ExternalPlugin from "./.quartz/plugins";

ExternalPlugin.NoteProperties({
  includeAll: false,
  includedProperties: ["description", "tags", "aliases"],
  excludedProperties: [],
  hidePropertiesView: false,
  delimiters: "---",
  language: "yaml",
});

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 exclude when includeAll is true.
hidePropertiesView boolean false Whether to hide the rendered properties view on the page.
delimiters string "---" The frontmatter delimiter style.
language string "yaml" The frontmatter language ("yaml" or "toml").

Documentation

See the Quartz documentation for more information.

License

MIT