Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: PageProperties component to show frontmatter similar to Obsidian #1720

Draft
wants to merge 2 commits into
base: v4
Choose a base branch
from

Conversation

necauqua
Copy link
Contributor

@necauqua necauqua commented Jan 14, 2025

This is my component for rendering the frontmatter in cases where frontmatter is an important part of your notes that you want to be visible.

It has overridable field renderers with a couple of defaults - hiding things, a tag renderer, and the default renderer that handles external links as well as obsidian-like internal links (that one could maybe be a config toggle too).

Otherwise, it's pretty simple - simple enough imo to include in quartz.

This is a draft because firstly it needs documentation (and I was lazy to write that), and also because it depends on #1673 - it's actually a soft dependency so that rendered frontmatter wikilinks appear in graphs and whatnot, but I also call the function I introduced there - so actually a hard dep.
But people have asked for it so here it is in public at least.

Note

Because GitHub sucks at stacked pull requests, until #1673 is merged (and I rebase it) this PR shows both the commit introducing the component and the commit from #1673, so if you actually review this please only look at the last commit specifically.

Example that I've shown already:

image

@necauqua necauqua changed the title feat(frontmatter): Add an option to index frontmatter wikilinks feat: PageProperties component to show frontmatter similar to Obsidian Jan 14, 2025
@necauqua necauqua force-pushed the page-props-component branch from 1f42eef to b54c119 Compare January 14, 2025 00:43
I was missing this feature and implemented it, not knowing that there
was jackyzha0#944 already ¯\_(ツ)_/¯

Looking at it now I think that my impl is a little better, and I'd love
to have it upstreamed.

Closes jackyzha0#820 and jackyzha0#944
@necauqua necauqua force-pushed the page-props-component branch 3 times, most recently from f20e938 to 3289cff Compare January 24, 2025 03:50
@necauqua necauqua force-pushed the page-props-component branch from 3289cff to 539611a Compare January 24, 2025 16:42
@aarnphm
Copy link
Collaborator

aarnphm commented Jan 26, 2025

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants