Fix broken internal markdown links in docs renderer#198
Open
JGPliskin wants to merge 1 commit intoshareAI-lab:mainfrom
Open
Fix broken internal markdown links in docs renderer#198JGPliskin wants to merge 1 commit intoshareAI-lab:mainfrom
JGPliskin wants to merge 1 commit intoshareAI-lab:mainfrom
Conversation
|
@JGPliskin is attempting to deploy a commit to the crazyboym's projects Team on Vercel. A member of the Team first needs to authorize it. |
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
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
Fix broken internal markdown links in the docs site.
Markdown links such as
./glossary.mdwere being rendered as raw relative hrefs, which caused broken URLs like:/zh/docs/s00-architecture-overview/glossary.mdinstead of routing to the app's actual doc pages.
Cause
The markdown renderer converted markdown content to HTML, but did not rewrite internal
.mdlinks to the site's route structure.Fix
Update the docs renderer to map internal markdown links using the generated docs index:
/{locale}/docs/{slug}/{locale}/{version}This keeps the markdown source unchanged while fixing navigation at render time.
Validation
npm run buildsuccessfully.mdhrefs for site docs