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.

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

New feature: A next/previous button for the docs section #176

Merged
merged 8 commits into from
Mar 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
63 changes: 62 additions & 1 deletion assets/scss/_elements_project.scss
Original file line number Diff line number Diff line change
Expand Up @@ -88,4 +88,65 @@ div.tip {
height: 22%;
float: right;
border-radius: 50%;
}
}

.prevBtn {
$btn-color: $primary;
$btn-color-dark: shade($btn-color, 40%);
color: tint($btn-color);

&:before {
content: '';
// @include absolute(0,0,0,0);
background-color: $btn-color-dark;
transform: translateX(-100%);
}

&:hover {
color: tint($btn-color, 75%);

&:before {
transform: translateX(0);
}
}
}

.pagination-nav {
grid-gap: 1rem;
display: grid;
gap: 1rem;
grid-template-columns: repeat(2, 1fr);
}


.pagination-nav__link {
border: 1px solid $lightslategray;
border-radius: 0.4rem;
display: block;
height: 100%;
line-height: 1.25;
padding: 1rem;
transition: border-color 200ms cubic-bezier(0.08,0.52,0.52,1);
}

.pagination-nav__link:hover {
border-color: $primary;
}

.pagination-nav__link--next {
grid-column: 2 / 3;
text-align: right;
}

.pagination-nav__sublabel{
color:$light;
font-size:0.875rem;
font-weight:500;
margin-bottom: 0.25rem;
}

.pagination-nav__label {
font-size: 1rem;
font-weight: 600;
word-break: break-word;
}
5 changes: 3 additions & 2 deletions content/en/cloud/overview/_index.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
<!-- ---
---
title: Overview
description: Here's where your user finds out if your project is for them.
weight: 2
categories: [Examples, Placeholders]
tags: [test, docs]
draft: true
---

<!--
{{% pageinfo %}}
Page under construction.
{{% /pageinfo %}}
Expand Down
5 changes: 3 additions & 2 deletions content/en/meshmap/tutorials/_index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
<!-- ---
---
title: Tutorials
description: Show your user how to work through some end to end examples.
date: 2023-10-30
weight: 8
draft: true
---

<!--
{{% pageinfo %}}
Page under construction.
{{% /pageinfo %}}
Expand Down
1 change: 1 addition & 0 deletions content/en/meshmap/tutorials/collaborative-editing.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ description: >
Learn about Collaborative Editing
weight: 5
categories: [Designer]
draft: true
---

{{% pageinfo %}}
Expand Down
1 change: 1 addition & 0 deletions content/en/meshmap/tutorials/publishing-to-catalog.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ title: Publishing to Catalog
description: >
Learn to Publish to Catalog
weight: 4
draft: true
---

{{% pageinfo %}}
Expand Down
2 changes: 1 addition & 1 deletion layouts/docs/baseof.html
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
<main class="col-12 col-md-9 col-xl-8 ps-md-5" role="main">
{{ partial "version-banner.html" . }} {{ if not
.Site.Params.ui.breadcrumb_disable }}{{ partial "breadcrumb.html" .
}}{{ end }} {{ block "main" . }}{{ end }}
}}{{ end }} {{ block "main" . }}{{ end }} {{ partial "pager.html" . }}
</main>
</div>
</div>
Expand Down
3 changes: 3 additions & 0 deletions layouts/docs/single.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{{ define "main" }}
{{ .Render "content" }}
{{ end }}
50 changes: 50 additions & 0 deletions layouts/partials/pager.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@

{{ $currentNode := . }}

{{ template "menu-nextprev" dict "menu" .Site.Home "currentnode" $currentNode }}

{{ define "menu-nextprev" }}
{{$currentNode := .currentnode }}
{{ if ne .menu.Params.hidden true}}
{{if hasPrefix $currentNode.RelPermalink .menu.RelPermalink }}
{{ $currentNode.Scratch.Set "NextPageOK" "OK" }}
{{ $currentNode.Scratch.Set "prevPage" ($currentNode.Scratch.Get "prevPageTmp") }}
{{else}}
{{if eq ($currentNode.Scratch.Get "NextPageOK") "OK"}}
{{ $currentNode.Scratch.Set "NextPageOK" nil }}
{{ $currentNode.Scratch.Set "nextPage" .menu }}
{{end}}
{{end}}
{{ $currentNode.Scratch.Set "prevPageTmp" .menu }}

{{ $currentNode.Scratch.Set "pages" .menu.Pages }}
{{ if .menu.IsHome}}
{{ $currentNode.Scratch.Set "pages" .menu.Sections }}
{{ else if .menu.Sections}}
{{ $currentNode.Scratch.Set "pages" (.menu.Pages | union .menu.Sections) }}
{{end}}
{{ $pages := ($currentNode.Scratch.Get "pages") }}

{{ range $pages.ByWeight }}
{{ template "menu-nextprev" dict "menu" . "currentnode" $currentNode }}
{{end}}
{{ end }}
{{ end }}

<nav class="pagination-nav mt-5" aria-label="Docs pages">
{{$showPrevNext := (and (not .Params.disableNextPrev) (not .Site.Params.disableNextPrev))}}
{{if $showPrevNext}}
{{with ($.Scratch.Get "prevPage")}}
<a class="pagination-nav__link pagination-nav__link--prev" href="{{.RelPermalink}}">
<div class="pagination-nav__sublabel">Previous</div>
<div class="pagination-nav__label"><i class="fa fa-chevron-left"></i> {{.Title}}</div>
</a>
{{end}}
{{with ($.Scratch.Get "nextPage")}}
<a class="pagination-nav__link pagination-nav__link--next" href="{{.RelPermalink}}">
<div class="pagination-nav__sublabel">Next</div>
<div class="pagination-nav__label">{{.Title}} <i class="fa fa-chevron-right"></i></div>
</a>
{{end}}
{{end}}
</nav>
Loading