fix(links): correct permalink and alias behavior to match Obsidian #2192
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
built with Refined Cloudflare Pages Action⚡ Cloudflare Pages Deployment
|
Author
|
Any thoughts @jackyzha0 ? |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This pull request implements comprehensive permalink support in Quartz, allowing pages to be rendered at custom URLs while ensuring all internal links, navigation components, and metadata use the permalink instead of the default file-based slug. The implementation correctly handles redirects from original file paths to permalinks and updates documentation to clarify the distinction between aliases and permalinks.
Key Changes:
- Added
permalinkSlugtracking throughout the system with aslugToPermalinkmap in build context - Updated all components and emitters to use permalink-aware linking via a new
getDisplaySlughelper function - Modified frontmatter processing to treat permalinks as the primary rendering target with automatic redirect creation
Reviewed Changes
Copilot reviewed 18 out of 18 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| quartz/util/path.ts | Added getDisplaySlug helper to choose between permalink and regular slug |
| quartz/util/ctx.ts | Extended BuildCtx with slugToPermalink mapping for permalink lookups |
| quartz/processors/parse.ts | Passes slugToPermalink map to parsing context |
| quartz/plugins/transformers/links.ts | Rewrites internal link hrefs to use permalinks when available |
| quartz/plugins/transformers/frontmatter.ts | Processes permalink frontmatter and creates redirect from original path |
| quartz/plugins/emitters/ogImage.tsx | Uses permalink for OG image generation |
| quartz/plugins/emitters/contentPage.tsx | Renders pages at permalink URL instead of file path |
| quartz/plugins/emitters/contentIndex.tsx | Includes displaySlug in content index for sitemap/RSS |
| quartz/plugins/emitters/aliases.ts | Redirects aliases to permalink URL when set |
| quartz/components/scripts/explorer.inline.ts | Updates explorer navigation to use permalink-aware links |
| quartz/components/pages/TagContent.tsx | Uses permalink for tag page links |
| quartz/components/TagList.tsx | Uses permalink for tag navigation |
| quartz/components/RecentNotes.tsx | Uses permalink for recent notes links |
| quartz/components/PageList.tsx | Uses permalink for page list links |
| quartz/components/Breadcrumbs.tsx | Uses permalink for breadcrumb navigation |
| quartz/components/Backlinks.tsx | Uses permalink for backlink references |
| quartz/build.ts | Builds and maintains slugToPermalink map during build and rebuild |
| docs/plugins/AliasRedirects.md | Documents permalink vs alias behavior with examples |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Author
|
@saberzero1 Some of the copilot suggestions were not correct and broke the types, so reverted those. Any other blockers? |
Author
|
Or things preventing this from being merged? |
247487a to
84d6484
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request adds robust support for permalinks in Quartz, allowing pages to be rendered at custom URLs while maintaining correct internal navigation, backlinks, breadcrumbs, tag links, and redirects. It ensures that if a page specifies a
permalinkin its frontmatter, all generated links and references use the permalink instead of the default file-based slug. The documentation is also updated to clarify the distinction between aliases and permalinks.This PR was written entirely using an LLM.