Repository navigation
docs: fix broken links in the muya and website package READMEs - #5668
Merged
Merged
Conversation
Jocs
approved these changes
Oct 8, 2026
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
Five relative links in the package READMEs point at files that don't exist:
packages/muya/README.mdlinksIMuyaOptionsandMUYA_DEFAULT_OPTIONSto./packages/core/src/..., a path from before muya moved into this repo. They now point to./src/types.tsand./src/config/index.ts, where both are defined.LICENSEnext to themselves; there is only the rootLICENSE, so they now use../../LICENSE.packages/website/content/docs/README.mdlinks "Installation instructions" to../README.md#download-and-installation, which doesn't exist undercontent/. It now linksend-user/INSTALLATION.md, which works on GitHub and whichrewriteHrefmaps to the installation page on marktext.me.I left
assets/marktext-interface-2.pngin the docs README alone: it only resolves on the site, where it is served frompublic/docs/assets.Type of change
Test plan
developand ran markdown-link-check on the three files.By submitting this pull request, I confirm that my contribution is made under the terms of the MIT license.