adding navigation to prev/next page in section

googlefonts · Sep 15, 2023 · f86eb69 · f86eb69
1 parent 2e29f57
commit f86eb69
Show file tree

Hide file tree

Showing 29 changed files with 87 additions and 8 deletions.
diff --git a/_config.yml b/_config.yml
@@ -4,6 +4,20 @@ description: Fontra user documentation
 baseurl: ""
 url: https://gferreira.github.io/fontra-docs
 
+collections:
+  explanations:
+    output: true
+    permalink: /:path/
+  how-tos:
+    output: true
+    permalink: /:path/
+  reference:
+    output: true
+    permalink: /:path/
+  tutorials:
+    output: true
+    permalink: /:path/
+
 markdown: kramdown
 
 version: 0.1

diff --git a/explanations/documentation.md → _explanations/documentation.md b/explanations/documentation.md → _explanations/documentation.md
@@ -2,6 +2,7 @@
 title     : Documentation overview
 layout    : default
 permalink : /explanations/documentation/
+order     : 2
 ---
 
 <nav aria-label="breadcrumb">
@@ -71,10 +72,10 @@ fontra-docs
 ├── _py/
 ├── css/
 ├── images/
-├── reference/
-├── explanations/
-├── tutorials/
-├── how-tos/
+├── _reference/
+├── _explanations/
+├── _tutorials/
+├── _how-tos/
 ├── index.md
 └── 404.html
 ```

diff --git a/explanations/explanations.md → _explanations/explanations.md b/explanations/explanations.md → _explanations/explanations.md
@@ -3,6 +3,7 @@ title     : Explanations
 layout    : default
 permalink : /explanations/
 draft     : true
+order     : 0
 ---
 
 theoretical knowledge · understanding-oriented · useful when studying

diff --git a/explanations/features-overview.md → _explanations/features-overview.md b/explanations/features-overview.md → _explanations/features-overview.md
@@ -3,6 +3,7 @@ title     : Features overview
 layout    : default
 permalink : /explanations/features/
 draft     : true
+order     : 2
 ---
 
 <nav aria-label="breadcrumb">

diff --git a/explanations/welcome.md → _explanations/welcome.md b/explanations/welcome.md → _explanations/welcome.md
@@ -3,6 +3,7 @@ title     : Welcome to Fontra
 layout    : default
 permalink : /explanations/welcome-to-fontra/
 draft     : true
+order     : 1
 ---
 
 <nav aria-label="breadcrumb">

diff --git a/how-tos/building-fontra-from-source.md → _how-tos/building-fontra-from-source.md b/how-tos/building-fontra-from-source.md → _how-tos/building-fontra-from-source.md
@@ -3,6 +3,7 @@ title     : Building Fontra from source
 layout    : default
 permalink : /how-tos/building-fontra-from-source/
 draft     : true
+order     : 2
 ---
 
 <nav aria-label="breadcrumb">

diff --git a/how-tos/how-tos.md → _how-tos/how-tos.md b/how-tos/how-tos.md → _how-tos/how-tos.md
@@ -3,6 +3,7 @@ title     : How-Tos
 layout    : default
 permalink : /how-tos/
 draft     : true
+order     : 0
 ---
 
 practical steps · problem-oriented · useful when working

diff --git a/how-tos/installing-fontra-pak.md → _how-tos/installing-fontra-pak.md b/how-tos/installing-fontra-pak.md → _how-tos/installing-fontra-pak.md
@@ -3,6 +3,7 @@ title     : Installing Fontra Pak on your computer
 layout    : default
 permalink : /how-tos/installing-fontra-pak/
 draft     : true
+order     : 1
 ---
 
 <nav aria-label="breadcrumb">

diff --git a/how-tos/opening-ufo-designspace.md → _how-tos/opening-ufo-designspace.md b/how-tos/opening-ufo-designspace.md → _how-tos/opening-ufo-designspace.md
@@ -3,6 +3,7 @@ title     : Opening a UFO or designspace file in Fontra
 layout    : default
 permalink : /how-tos/opening-ufo-designspace/
 draft     : true
+order     : 3
 ---
 
 <nav aria-label="breadcrumb">

diff --git a/_layouts/default.html b/_layouts/default.html
@@ -12,14 +12,52 @@
   <script src="https://code.jquery.com/jquery-3.6.0.slim.min.js" integrity="sha256-u7e5khyithlIdTpu22PHhENmPcRdFiHRjhAuHcs05RI=" crossorigin="anonymous"></script>
 </head>
 
+{% if page.collection %}
+  {% capture all_pages %}{{ page.collection }}{% endcapture %}
+  {% assign pages = site[all_pages] | sort: "order" %}
+  {% for nav_page in pages %}
+    {% if nav_page.title == page.title %}
+      {% unless forloop.first %}
+        {% assign prev_url = prev.url %}
+        {% assign prev_title = prev.title %}
+      {% endunless %}
+      {% unless forloop.last %}
+        {% assign next = pages[forloop.index] %}
+        {% assign next_url = next.url %}
+        {% assign next_title = next.title %}
+      {% endunless %}
+    {% endif %}
+    {% assign prev = nav_page %}
+  {% endfor %}
+{% endif %}
+
 <body class='d-flex flex-column h-100'>
   {% include header.html %}
   <main class='flex-shrink-0'>
     <div class="container px-lg-4 pt-3 pb-4">
-      {% if page.draft == true %}
-        <div class="badge text-bg-warning float-end mt-2">draft</div>
-      {% endif %}
-      <h1 class='col-12'>{{ page.title }}</h1>
+
+      <div class='row'>
+        <h1 class='col-9'>{{ page.title }}</h1>
+        {% if page.collection %}
+          {% if prev_url or next_url %}
+            <nav class='col-3 mt-2'>
+              <ul class="pagination pagination-sm float-end">
+                {% if prev_url %}
+                  <li class="page-item">
+                    <a class="page-link px-3 prev" href="{{ site.url }}/{{prev_url}}" title='{{ prev_title }}'>&laquo;</a>
+                  </li>
+                {% endif %}
+                {% if next_url %}
+                  <li class="page-item">
+                    <a class="page-link px-3 next" href="{{ site.url }}/{{next_url}}" title='{{ next_title }}'>&raquo;</a>
+                  </li>
+                {% endif %}
+              </ul>
+            </nav>
+          {% endif %}
+        {% endif %}
+      </div>
+
       {{ content }}
     </div>
   </main>

diff --git a/reference/canvas.md → _reference/canvas.md b/reference/canvas.md → _reference/canvas.md
@@ -3,6 +3,7 @@ title     : Canvas
 layout    : default
 permalink : /reference/canvas/
 draft     : true
+order     : 2
 ---
 
 <nav aria-label="breadcrumb">

diff --git a/reference/menu.md → _reference/menu.md b/reference/menu.md → _reference/menu.md
@@ -3,6 +3,7 @@ title     : Menu
 layout    : default
 permalink : /reference/menu/
 draft     : true
+order     : 16
 ---
 
 <nav aria-label="breadcrumb">

diff --git a/reference/navigation.md → _reference/navigation.md b/reference/navigation.md → _reference/navigation.md
@@ -3,6 +3,7 @@ title     : Navigation
 layout    : default
 permalink : /reference/navigation/
 draft     : true
+order     : 3
 ---
 
 <nav aria-label="breadcrumb">

diff --git a/reference/panels.md → _reference/panels.md b/reference/panels.md → _reference/panels.md
@@ -3,6 +3,7 @@ title     : Panels
 layout    : default
 permalink : /reference/panels/
 draft     : true
+order     : 9
 ---
 
 <nav aria-label="breadcrumb">

diff --git a/reference/panels/designspace.md → _reference/panels/designspace.md b/reference/panels/designspace.md → _reference/panels/designspace.md
@@ -3,6 +3,7 @@ title     : Designspace
 layout    : default
 permalink : /reference/panels/designspace
 draft     : true
+order     : 12
 ---
 
 <nav aria-label="breadcrumb">

diff --git a/reference/panels/find-glyph.md → _reference/panels/find-glyph.md b/reference/panels/find-glyph.md → _reference/panels/find-glyph.md
@@ -3,6 +3,7 @@ title     : Find glyph
 layout    : default
 permalink : /reference/panels/find-glyph
 draft     : true
+order     : 11
 ---
 
 <nav aria-label="breadcrumb">

diff --git a/reference/panels/glyph-info.md → _reference/panels/glyph-info.md b/reference/panels/glyph-info.md → _reference/panels/glyph-info.md
@@ -3,6 +3,7 @@ title     : Glyph info
 layout    : default
 permalink : /reference/panels/glyph-info
 draft     : true
+order     : 15
 ---
 
 <nav aria-label="breadcrumb">

diff --git a/reference/panels/options.md → _reference/panels/options.md b/reference/panels/options.md → _reference/panels/options.md
@@ -3,6 +3,7 @@ title     : Options panel
 layout    : default
 permalink : /reference/panels/options
 draft     : true
+order     : 13
 ---
 
 <nav aria-label="breadcrumb">

diff --git a/reference/panels/preview-text.md → _reference/panels/preview-text.md b/reference/panels/preview-text.md → _reference/panels/preview-text.md
@@ -3,6 +3,7 @@ title     : Preview text
 layout    : default
 permalink : /reference/panels/preview-text
 draft     : true
+order     : 10
 ---
 
 <nav aria-label="breadcrumb">

diff --git a/reference/panels/reference-font.md → _reference/panels/reference-font.md b/reference/panels/reference-font.md → _reference/panels/reference-font.md
@@ -3,6 +3,7 @@ title     : Reference font
 layout    : default
 permalink : /reference/panels/reference-font
 draft     : true
+order     : 14
 ---
 
 <nav aria-label="breadcrumb">

diff --git a/reference/reference.md → _reference/reference.md b/reference/reference.md → _reference/reference.md
@@ -3,6 +3,7 @@ title     : Reference
 layout    : default
 permalink : /reference/
 draft     : true
+order     : 0
 ---
 
 theoretical knowledge · information-oriented · useful when working

diff --git a/reference/tools.md → _reference/tools.md b/reference/tools.md → _reference/tools.md
@@ -3,6 +3,7 @@ title     : Tools
 layout    : default
 permalink : /reference/tools/
 draft     : true
+order     : 4
 ---
 
 <nav aria-label="breadcrumb">

diff --git a/reference/tools/hand.md → _reference/tools/hand.md b/reference/tools/hand.md → _reference/tools/hand.md
@@ -3,6 +3,7 @@ title     : Hand tool
 layout    : default
 permalink : /reference/tools/hand
 draft     : true
+order     : 8
 ---
 
 <nav aria-label="breadcrumb">

diff --git a/reference/tools/pen.md → _reference/tools/pen.md b/reference/tools/pen.md → _reference/tools/pen.md
@@ -3,6 +3,7 @@ title     : Pen tool
 layout    : default
 permalink : /reference/tools/pen
 draft     : true
+order     : 6
 ---
 
 <nav aria-label="breadcrumb">

diff --git a/reference/tools/pointer.md → _reference/tools/pointer.md b/reference/tools/pointer.md → _reference/tools/pointer.md
@@ -3,6 +3,7 @@ title     : Pointer tool
 layout    : default
 permalink : /reference/tools/pointer
 draft     : true
+order     : 5
 ---
 
 <nav aria-label="breadcrumb">

diff --git a/reference/tools/ruler.md → _reference/tools/ruler.md b/reference/tools/ruler.md → _reference/tools/ruler.md
@@ -3,6 +3,7 @@ title     : Ruler
 layout    : default
 permalink : /reference/tools/ruler
 draft     : true
+order     : 7
 ---
 
 <nav aria-label="breadcrumb">

diff --git a/reference/workspace.md → _reference/workspace.md b/reference/workspace.md → _reference/workspace.md
@@ -3,6 +3,7 @@ title     : Workspace overview
 layout    : default
 permalink : /reference/workspace/
 draft     : true
+order     : 1
 ---
 
 <nav aria-label="breadcrumb">

diff --git a/tutorials/tutorials.md → _tutorials/tutorials.md b/tutorials/tutorials.md → _tutorials/tutorials.md
@@ -3,6 +3,7 @@ title     : Tutorials
 layout    : default
 permalink : /tutorials/
 draft     : true
+order     : 0
 ---
 
 practical steps · learning-oriented · useful when studying

diff --git a/...ials/understanding-variable-components.md → ...ials/understanding-variable-components.md b/...ials/understanding-variable-components.md → ...ials/understanding-variable-components.md
@@ -3,6 +3,7 @@ title     : Understanding variable components
 layout    : default
 permalink : /tutorials/understanding-variable-components/
 draft     : true
+order     : 1
 ---
 
 <nav aria-label="breadcrumb">