Skip to content
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

Prev and next links #272

Merged
merged 4 commits into from
Aug 16, 2022
Merged

Prev and next links #272

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7c5312e
feat: add links for prev and next guide page
robin4a4 Aug 12, 2022
da8c189
feat: add pagination component
robin4a4 Aug 14, 2022
e0b7060
add working prev and next links
Aug 15, 2022
8b4a45c
revert the lock file to main
Aug 15, 2022
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
32 changes: 30 additions & 2 deletions docs/_layouts/guide.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,43 @@
layout: default
---

{% assign sidebarItems = site.guide | sort: 'chapter' %}

{% for item in sidebarItems %}
{% if item.title == page.title %}
{% unless forloop.first %}
{% assign prevIndex = forloop.index| minus: 2 %}
{% assign prev = sidebarItems[prevIndex] %}
{% endunless %}
{% unless forloop.last %}
{% assign nextIndex = forloop.index %}
{% assign next = sidebarItems[nextIndex] %}
{% endunless %}
{% endif %}
{% endfor %}

<div class="d-md-flex flex-1">
{% assign sidebarItems = site.guide | sort: 'chapter' %}
{% include sidebar.html %}

<section class="col-lg-9 px-5 f4">
<div class="container-md markdown-body mb-5">
<h1 class="mb-4 f0-light">{{ page.title }}</h1>
{{ content }}
<div class="mt-4">
<nav class="prev-next-links" aria-label="Pagination">
{% if prev %}
<a class="prev-next-links__button" rel="previous" href="{{prev.url}}" aria-label="Previous Page">
<div class="f6 text-uppercase">Previous</div>
{{prev.title}}
</a>
{% endif %} {% if next %}
<a class="prev-next-links__button" rel="next" href="{{next.url}}" aria-label="Next Page">
<div class="f6 text-uppercase">Next</div>
{{next.title}}
</a>
{% endif %}
</nav>
</div>
</div>
</section>

</div>
82 changes: 65 additions & 17 deletions docs/custom.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,29 @@
pre { font-size: 100% !important }
code { font-size: 90% !important }
pre {
font-size: 100% !important;
}
code {
font-size: 90% !important;
}

h1, h2, h3, h4, h5 { margin: 1rem 0; width: 100%; }
ul li { margin-left: 1rem }
h1,
h2,
h3,
h4,
h5 {
margin: 1rem 0;
width: 100%;
}
ul li {
margin-left: 1rem;
}

.top-100px { top: 100px }
.top-100px {
top: 100px;
}

/* No preference or prefers light */
:root:not([data-prefers-color-scheme=dark]),
html[data-prefers-color-scheme=light] {
:root:not([data-prefers-color-scheme='dark']),
html[data-prefers-color-scheme='light'] {
--color-bg-canvas: rgb(255, 255, 255);
--color-bg-canvas-shadow: rgba(255, 255, 255, 0);
--color-bg-canvas-tertiary: #f6f8fa;
Expand All @@ -17,7 +32,7 @@ html[data-prefers-color-scheme=light] {
--color-accent-fg: #0969da;
}
/* Prefers dark */
html[data-prefers-color-scheme=dark] {
html[data-prefers-color-scheme='dark'] {
--color-bg-canvas: rgb(13, 17, 23);
--color-bg-canvas-shadow: rgba(13, 17, 23, 0);
--color-bg-canvas-tertiary: #161b22;
Expand All @@ -26,7 +41,7 @@ html[data-prefers-color-scheme=dark] {
--color-accent-fg: #58a6ff;
}
@media (prefers-color-scheme: dark) {
:root:not([data-prefers-color-scheme=light]) {
:root:not([data-prefers-color-scheme='light']) {
--color-bg-canvas: rgb(13, 17, 23);
--color-bg-canvas-shadow: rgba(13, 17, 23, 0);
--color-bg-canvas-tertiary: #161b22;
Expand All @@ -42,30 +57,63 @@ body {
}

a {
color: var(--color-accent-fg)
color: var(--color-accent-fg);
}

/* Sidebar */
/* NB: `!important` is already used; so it’s required here */
.bg-gray { background-color: var(--color-bg-canvas-tertiary) !important }
.bg-gray {
background-color: var(--color-bg-canvas-tertiary) !important;
}

/* Code Blocks & Syntax */
.markdown-body .highlight pre, .markdown-body pre {
.markdown-body .highlight pre,
.markdown-body pre {
background-color: var(--color-bg-canvas-tertiary);
overflow: auto;
}

/* Inline Code */
.markdown-body code, .markdown-body tt { background-color: var(--color-markdown-code-bg) }
.markdown-body code,
.markdown-body tt {
background-color: var(--color-markdown-code-bg);
}

/* Tables */
.markdown-body table tr:nth-of-type(odd) th, .markdown-body table tr:nth-of-type(odd) td { background-color: var(--color-bg-canvas) }
.markdown-body table tr:nth-of-type(even) th, .markdown-body table tr:nth-of-type(even) td { background-color: var(--color-bg-canvas-tertiary) }
.markdown-body table tr:nth-of-type(odd) th,
.markdown-body table tr:nth-of-type(odd) td {
background-color: var(--color-bg-canvas);
}
.markdown-body table tr:nth-of-type(even) th,
.markdown-body table tr:nth-of-type(even) td {
background-color: var(--color-bg-canvas-tertiary);
}

/* Override Primer .tooltipped default aria-label */
.code-tooltip:after { content: attr(data-title); text-align: left; font-size: 100%; }
.code-tooltip:after {
content: attr(data-title);
text-align: left;
font-size: 100%;
}
/* :after text will be announced by AT, this adds a separation between textContent and :after text */
.code-tooltip:before { content: ': '; font-size: 0; }
.code-tooltip:before {
content: ': ';
font-size: 0;
}
.code-tooltip {
scroll-margin-top: 150px;
}


/* Prev and next links */
.prev-next-links {
display: flex;
gap: 16px;
}

.prev-next-links__button {
border: solid 1px;
padding: 16px;
border-radius: 4px;
flex: 1;
}