mirror of
https://github.com/quartz-community/note-properties.git
synced 2026-07-22 02:50:26 +00:00
No description
3539cf1e6a
Wikilinks appearing in frontmatter property strings (e.g. 'related: "[[My Note]]"') were rendered with their raw target passed directly to resolveRelative, leaving the space intact. The browser then percent-encoded it as %20 in the rendered href, producing broken links like './My%20Note' that never resolve. The root cause was in renderTextWithLinks (NoteProperties.tsx): the matched wikilink target went straight into resolveRelative without going through slugifyFilePath, so spaces, ampersands, and other characters that should be slugified survived into the href. extractLinksFromValue (transformer.ts) had the same issue: it stored raw target strings in file.data.frontmatterLinks instead of canonical slugs. Adds a shared slugifyWikilinkTarget helper in util/path.ts that mirrors the slug+anchor contract CrawlLinks uses for body-content links, so frontmatter wikilinks and body wikilinks now produce identical hrefs. Both NoteProperties.tsx and the transformer's extractLinksFromValue now go through this helper. Also replaces the plugin's local slugTag/slugifyFilePath/ getFileExtension helpers with the shared @quartz-community/utils versions. This eliminates slugification drift between plugins and ensures that note-properties honors the same case-insensitive matching that the rest of the Quartz ecosystem uses. BREAKING CHANGE: tag URLs and frontmatter-wikilink slugs are now lowercased (inherited from utils' case-insensitive matching). Tags #MyTag, #mytag, and #MYTAG collapse into a single tag page tags/mytag. |
||
|---|---|---|
| .github/workflows | ||
| dist | ||
| src | ||
| test | ||
| types | ||
| .eslintrc.json | ||
| .gitignore | ||
| .prettierignore | ||
| .prettierrc | ||
| CHANGELOG.md | ||
| LICENSE | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| tsconfig.build.json | ||
| tsconfig.json | ||
| tsup.config.ts | ||
| vitest.config.ts | ||
@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