Add MkDocs Source Links#416
Open
filipchristiansen wants to merge 1 commit into
Open
Conversation
Author
|
The failing Since This PR's entry validates cleanly — installing Only |
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.
What kind of change does this PR introduce?
Description:
Adds MkDocs Source Links (
pypi: mkdocs-source-links, plugin namesource-links, categorylinks-refs).MkDocs plugin that rewrites parent-directory (
](../path)) markdown links to your git forge's view URLs in the built HTML only. Source markdown keeps working relative paths (so links still resolve on the forge and in your IDE); files becomeblobURLs and directoriestreeURLs, with the branch resolved from config /edit_uri. Supports GitHub (incl. Enterprise), GitLab, Bitbucket, Gitea/Forgejo (incl. Codeberg), and Azure DevOps, with host autodetection and an explicitforgeoverride. Docs: https://filipchristiansen.github.io/mkdocs-source-links/Checklist:
README.mdfile. Projects are only supposed to be added or updated within theprojects.yamlfile since theREADME.mdfile is automatically generated.