Skip to content

Add "Edit on GitHub" links to every documentation page #16

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

Merged
daliborturbeki merged 2 commits into from
Jan 17, 2026
Merged

Add "Edit on GitHub" links to every documentation page #16

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
12e0d04
docs: add edit on github button on every page
daliborturbeki Jan 16, 2026
31af6e1
docs: run lint on edit on github button
daliborturbeki Jan 16, 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
1 change: 1 addition & 0 deletions docs/astro.config.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ export default defineConfig({
// Component overrides for custom design
components: {
Sidebar: "./src/components/overrides/Sidebar.astro",
EditLink: "./src/components/overrides/EditLink.astro",
},
// Autogenerate sidebar from directory structure
// Contributors only need to add frontmatter to control ordering
Expand Down
50 changes: 50 additions & 0 deletions docs/src/components/overrides/EditLink.astro
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
const path = Astro.url.pathname.slice(1).replace(/\/$/, "") || "index";
---

<div class="edit-link-wrapper">
<a
href={`https://github.com/HyperTekOrg/hyperstack/blob/main/docs/src/content/docs/${path}.mdx`}
target="_blank"
rel="noopener noreferrer"
class="edit-link"
>
<svg
xmlns="http://www.w3.org/2000/svg"
viewBox="0 0 16 16"
fill="currentColor"
width="20"
height="20"
>
<path
d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0016 8c0-4.42-3.58-8-8-8z"
></path>
</svg>
<span>Edit on GitHub</span>
</a>
</div>

<style>
.edit-link-wrapper {
margin-top: 2rem;
padding-top: 1rem;
}

.edit-link {
display: inline-flex;
align-items: center;
gap: 0.5rem;
color: var(--sl-color-text-accent);
text-decoration: none;
font-size: 0.9rem;
transition: color 0.2s ease;
}

.edit-link:hover {
text-decoration: underline;
}

.edit-link svg {
flex-shrink: 0;
}
</style>