Skip to content

Enhancement: Github edit link for the docs pages #289

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
Fran-A-Dev merged 3 commits into from
Feb 21, 2025
Merged

Enhancement: Github edit link for the docs pages #289

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1583600
Added a link to edit the doc on Github
colinmurphy Feb 21, 2025
6fa83f6
Merge branch 'main' into feature-add-edit-this-on-github-link
colinmurphy Feb 21, 2025
014a669
Updated wording for the link
colinmurphy Feb 21, 2025
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
12 changes: 12 additions & 0 deletions src/components/docs-layout.jsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import DocsBreadcrumbs from "./docs-breadcrumbs";
import DocsPreviousNextLinks from "./docs-previous-next-link";
import OnThisPageNav from "./on-this-page-nav";
import DocsNav from "@/components/docs-nav";
import Link from "@/components/link";
import Seo from "@/components/seo";
import routes from "@/pages/docs/nav.json";
import "rehype-callouts/theme/vitepress";
Expand Down Expand Up @@ -62,6 +63,7 @@ export default function DocumentPage({ children, metadata }) {
<main
id="main-content"
className="relative mx-auto flex max-w-full grid-cols-[1fr_auto_1fr] flex-col gap-6 md:grid"
style={{ lineHeight: "1.6em" }}
>
<nav className="custom-scrollbar sticky top-[84px] hidden h-[calc(100vh-84px)] w-64 overflow-y-auto p-4 md:block">
<a href="#docs-article" className="faust-skip-link">
Expand All @@ -71,6 +73,16 @@ export default function DocumentPage({ children, metadata }) {
</nav>
<nav className="sticky top-[84px] order-last hidden h-[calc(100vh-84px)] w-[240px] overflow-y-auto p-6 lg:block">
<OnThisPageNav>{children}</OnThisPageNav>

<div className="my-6 border-t border-gray-700" />

<Link
className="leading-loose font-normal text-gray-400 no-underline hover:text-blue-500"
href={`https://github.com/wpengine/faustjs.org/edit/main/src/pages${asPath}index.mdx`}
noDefaultStyles
>
Improve & Edit this doc on GitHub
</Link>
</nav>
<article
id="docs-article"
Expand Down