Skip to content

dx: add “Edit this page on GitHub” links #265 #271

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Shivampal157 wants to merge 2 commits into
base: main
Choose a base branch
from
Open

dx: add “Edit this page on GitHub” links #265 #271

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6823f05
dx: add edit links for docs and blog pages #265
Shivampal157 Mar 17, 2026
cd9b3de
Merge remote-tracking branch 'upstream/main' into dx/edit-github-link…
Shivampal157 Mar 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
site_name: Open Science Labs
site_url: https://opensciencelabs.org

# Repository / edit links (used to build "Edit this page on GitHub" URLs)
repo_url: https://github.com/OpenScienceLabs/opensciencelabs.github.io
edit_uri: edit/main/

docs_dir: pages
site_dir: build

Expand Down
10 changes: 10 additions & 0 deletions theme/base.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -373,6 +373,16 @@ <h2 class="accordion-header" id="h-{{ pid }}">
{% block content_inner %}
{{ page.content }}
{% endblock content_inner %}

{# Inline "Edit this page on GitHub" helper. Uses MkDocs page.edit_url. #}
{% if page.edit_url %}
<div class="mt-4 edit-on-github">
<a href="{{ page.edit_url }}" target="_blank" rel="noopener"
class="edit-link small text-secondary">
Found an issue? <span class="edit-link-text">Edit this page on GitHub ↗</span>
</a>
</div>
{% endif %}
</div>
</div>
</section>
Expand Down
11 changes: 11 additions & 0 deletions theme/css/content.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,14 @@ blockquote{
display: grid; place-items: center;
}
.to_top .icon { width: 24px; height: 24px; }

/* "Edit this page on GitHub" helper */
.edit-on-github {
margin-top: 1.25rem;
}
.edit-on-github .edit-link {
text-decoration: none;
}
.edit-on-github .edit-link:hover {
text-decoration: underline;
}
Loading