fix(docs): use pathname:// for sitemap footer link#1279
Merged
Conversation
Docusaurus's broken-link checker validates `to:` against routed pages, but /sitemap.xml is a static artifact emitted by the sitemap plugin. Treating it as a route caused the broken-link check to fail on every page and broke the docs build. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
|
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
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.
Summary
/sitemap.xml.{ label: 'Sitemap', to: '/sitemap.xml' }. Docusaurus's broken-link checker validatesto:targets against routed pages, but/sitemap.xmlis a static artifact emitted by@docusaurus/plugin-sitemap, not a route — so the checker flags it as broken on every page.href: 'pathname:///sitemap.xml'. Thepathname://prefix is the documented Docusaurus escape hatch that tells the link processor to treat the value as a literal URL path (bypassing the broken-link check).Failing run for reference: https://github.com/mathuo/dockview/actions/runs/25828829653
Test plan
/sitemap.xmlon the deployed site🤖 Generated with Claude Code