Skip to content

[doc] add prev/next on docs page #152

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
samsonasik merged 2 commits into from
Jun 8, 2026
Merged

[doc] add prev/next on docs page #152

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
8a2b9c6
[doc] add prev/next on docs page
samsonasik Jun 8, 2026
9cead35
[doc] add prev/next on docs page
samsonasik Jun 8, 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
45 changes: 45 additions & 0 deletions docs/_includes/footer_custom.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
{%- assign docs_pages = site.html_pages
| where_exp: "item", "item.title != nil"
| where_exp: "item", "item.parent == nil"
| where_exp: "item", "item.nav_exclude != true" -%}
{%- include components/nav/sorted.html pages=docs_pages -%}

{%- assign previous_doc = nil -%}
{%- assign next_doc = nil -%}
{%- assign current_doc_found = false -%}

{%- for docs_page in nav_sorted -%}
{%- if current_doc_found -%}
{%- assign next_doc = docs_page -%}
{%- break -%}
{%- endif -%}

{%- if docs_page.url == page.url -%}
{%- assign current_doc_found = true -%}
{%- else -%}
{%- assign previous_doc = docs_page -%}
{%- endif -%}
{%- endfor -%}

{%- if current_doc_found -%}
{%- if previous_doc or next_doc -%}
<nav class="sa-page-nav" aria-label="Page navigation">
<div class="sa-page-nav__slot sa-page-nav__slot--prev">
{%- if previous_doc -%}
<a class="sa-page-nav__link" href="{{ previous_doc.url | relative_url }}">
<span class="sa-page-nav__eyebrow">&larr; Prev</span>
<span class="sa-page-nav__title">{{ previous_doc.nav_title | default: previous_doc.title }}</span>
</a>
{%- endif -%}
</div>
<div class="sa-page-nav__slot sa-page-nav__slot--next">
{%- if next_doc -%}
<a class="sa-page-nav__link" href="{{ next_doc.url | relative_url }}">
<span class="sa-page-nav__eyebrow">Next &rarr;</span>
<span class="sa-page-nav__title">{{ next_doc.nav_title | default: next_doc.title }}</span>
</a>
{%- endif -%}
</div>
</nav>
{%- endif -%}
{%- endif -%}
53 changes: 53 additions & 0 deletions docs/_sass/custom/custom.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,6 +276,59 @@ figure.highlight code {
border-color: #1a7f37;
}

.sa-page-nav {
display: grid;
grid-template-columns: repeat(2, minmax(0, 1fr));
gap: 0.75rem;
margin: 1rem 0 0;
}

.sa-page-nav__slot--next {
text-align: right;
}

.sa-page-nav__link {
display: block;
min-height: 4.25rem;
padding: 0.75rem 0.85rem;
border: 1px solid #d0d7de;
border-radius: 6px;
background: #ffffff;
color: inherit;
text-decoration: none;
}

.sa-page-nav__link:hover,
.sa-page-nav__link:focus-visible {
border-color: #8c959f;
text-decoration: none;
}

.sa-page-nav__eyebrow {
display: block;
color: #6e7781;
font-size: 0.72rem;
font-weight: 700;
letter-spacing: 0.04em;
line-height: 1.2;
text-transform: uppercase;
}

.sa-page-nav__title {
display: block;
margin-top: 0.3rem;
color: #0969da;
font-weight: 600;
line-height: 1.3;
overflow-wrap: anywhere;
}

@media (max-width: 31rem) {
.sa-page-nav {
grid-template-columns: 1fr;
}
}

.highlight .c,
.highlight .c1,
.highlight .cm,
Expand Down
Loading