Fix MkDocs “Edit on GitHub” links#27
Merged
Snowflake-Pink merged 2 commits intoOpenFuTech:mainfrom May 5, 2026
Merged
Conversation
Snowflake-Pink
approved these changes
May 3, 2026
Elaina-Official
approved these changes
May 5, 2026
Contributor
|
LGTM. Thanks for pr |
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
3 participants
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 PR fixes broken “Edit on GitHub” links on the generated MkDocs site.
Previously, MkDocs used its default GitHub edit URI, which generated links like:
/edit/master/docs/01-基础必修课/C++编程基础.mdHowever, this repository now uses main, and the editable source files live outside docs/, for example:
01-基础必修课/C++编程基础/README.mdChanges included:
The sample page now generates the expected edit link:
https://github.com/OpenFuTech/SCUT-FT-Guide/edit/main/01-基础必修课/C++编程基础/README.mdKnown issue:
docs/02-专业基础课/数字系统设计实验.mdwill map to02-专业基础课/数字系统设计实验/README.mdbut that source README.md does not currently exist. This appears to be an existing content-structure issue.