dx: add “Edit this page on GitHub” links #265#271
Open
Shivampal157 wants to merge 2 commits intoOpenScienceLabs:mainfrom
Open
dx: add “Edit this page on GitHub” links #265#271Shivampal157 wants to merge 2 commits intoOpenScienceLabs:mainfrom
Shivampal157 wants to merge 2 commits intoOpenScienceLabs:mainfrom
Conversation
Author
|
Hi @xmnlab, could you please review this PR when you have a moment and let me know if any changes are needed? |
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.
This PR wires up MkDocs’ edit URLs and shows a small “Edit this page on GitHub” link on docs and blog posts.
What changed
issue: #265
repo_urlandedit_uriinmkdocs.ymlso MkDocs exposespage.edit_url.theme/base.html, render a short “Found an issue? Edit this page on GitHub ↗” helper below the main content whenpage.edit_urlis available.theme/css/content.cssso the link looks consistent with the rest of the theme.Notes
base.html, so it applies both to regular docs and to blog posts that useblog-post.html/ other inherited layouts.OpenScienceLabs/opensciencelabs.github.io) on themainbranch.