From f86eb6987ab6a12a4b8ce019681b37198782261c Mon Sep 17 00:00:00 2001
From: gferreira <gustavo@hipertipo.com>
Date: Fri, 15 Sep 2023 15:40:15 -0300
Subject: [PATCH] adding navigation to prev/next page in section

---
 _config.yml                                   | 14 ++++++
 .../documentation.md                          |  9 ++--
 .../explanations.md                           |  1 +
 .../features-overview.md                      |  1 +
 {explanations => _explanations}/welcome.md    |  1 +
 .../building-fontra-from-source.md            |  1 +
 {how-tos => _how-tos}/how-tos.md              |  1 +
 .../installing-fontra-pak.md                  |  1 +
 .../opening-ufo-designspace.md                |  1 +
 _layouts/default.html                         | 46 +++++++++++++++++--
 {reference => _reference}/canvas.md           |  1 +
 {reference => _reference}/menu.md             |  1 +
 {reference => _reference}/navigation.md       |  1 +
 {reference => _reference}/panels.md           |  1 +
 .../panels/designspace.md                     |  1 +
 .../panels/find-glyph.md                      |  1 +
 .../panels/glyph-info.md                      |  1 +
 {reference => _reference}/panels/options.md   |  1 +
 .../panels/preview-text.md                    |  1 +
 .../panels/reference-font.md                  |  1 +
 {reference => _reference}/reference.md        |  1 +
 {reference => _reference}/tools.md            |  1 +
 {reference => _reference}/tools/hand.md       |  1 +
 {reference => _reference}/tools/pen.md        |  1 +
 {reference => _reference}/tools/pointer.md    |  1 +
 {reference => _reference}/tools/ruler.md      |  1 +
 {reference => _reference}/workspace.md        |  1 +
 {tutorials => _tutorials}/tutorials.md        |  1 +
 .../understanding-variable-components.md      |  1 +
 29 files changed, 87 insertions(+), 8 deletions(-)
 rename {explanations => _explanations}/documentation.md (97%)
 rename {explanations => _explanations}/explanations.md (95%)
 rename {explanations => _explanations}/features-overview.md (96%)
 rename {explanations => _explanations}/welcome.md (99%)
 rename {how-tos => _how-tos}/building-fontra-from-source.md (96%)
 rename {how-tos => _how-tos}/how-tos.md (97%)
 rename {how-tos => _how-tos}/installing-fontra-pak.md (99%)
 rename {how-tos => _how-tos}/opening-ufo-designspace.md (98%)
 rename {reference => _reference}/canvas.md (99%)
 rename {reference => _reference}/menu.md (99%)
 rename {reference => _reference}/navigation.md (99%)
 rename {reference => _reference}/panels.md (99%)
 rename {reference => _reference}/panels/designspace.md (98%)
 rename {reference => _reference}/panels/find-glyph.md (98%)
 rename {reference => _reference}/panels/glyph-info.md (98%)
 rename {reference => _reference}/panels/options.md (98%)
 rename {reference => _reference}/panels/preview-text.md (98%)
 rename {reference => _reference}/panels/reference-font.md (98%)
 rename {reference => _reference}/reference.md (98%)
 rename {reference => _reference}/tools.md (98%)
 rename {reference => _reference}/tools/hand.md (97%)
 rename {reference => _reference}/tools/pen.md (98%)
 rename {reference => _reference}/tools/pointer.md (99%)
 rename {reference => _reference}/tools/ruler.md (98%)
 rename {reference => _reference}/workspace.md (98%)
 rename {tutorials => _tutorials}/tutorials.md (94%)
 rename {tutorials => _tutorials}/understanding-variable-components.md (97%)

diff --git a/_config.yml b/_config.yml
index 6559b21..a376742 100644
--- 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 b/_explanations/documentation.md
similarity index 97%
rename from explanations/documentation.md
rename to _explanations/documentation.md
index 5ad04b0..17b7b6b 100644
--- a/explanations/documentation.md
+++ b/_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 b/_explanations/explanations.md
similarity index 95%
rename from explanations/explanations.md
rename to _explanations/explanations.md
index 72e93d2..a73f998 100644
--- a/explanations/explanations.md
+++ b/_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 b/_explanations/features-overview.md
similarity index 96%
rename from explanations/features-overview.md
rename to _explanations/features-overview.md
index 6610b15..58a36ac 100644
--- a/explanations/features-overview.md
+++ b/_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 b/_explanations/welcome.md
similarity index 99%
rename from explanations/welcome.md
rename to _explanations/welcome.md
index 8d89ffd..336ffe3 100644
--- a/explanations/welcome.md
+++ b/_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 b/_how-tos/building-fontra-from-source.md
similarity index 96%
rename from how-tos/building-fontra-from-source.md
rename to _how-tos/building-fontra-from-source.md
index 83bb5a9..0c24a24 100644
--- a/how-tos/building-fontra-from-source.md
+++ b/_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 b/_how-tos/how-tos.md
similarity index 97%
rename from how-tos/how-tos.md
rename to _how-tos/how-tos.md
index 5127db4..177e007 100644
--- a/how-tos/how-tos.md
+++ b/_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 b/_how-tos/installing-fontra-pak.md
similarity index 99%
rename from how-tos/installing-fontra-pak.md
rename to _how-tos/installing-fontra-pak.md
index 6ebce69..8d8f2cf 100644
--- a/how-tos/installing-fontra-pak.md
+++ b/_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 b/_how-tos/opening-ufo-designspace.md
similarity index 98%
rename from how-tos/opening-ufo-designspace.md
rename to _how-tos/opening-ufo-designspace.md
index c02e6de..4ae02bf 100644
--- a/how-tos/opening-ufo-designspace.md
+++ b/_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
index 9ed39bf..8b4b54f 100644
--- 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 b/_reference/canvas.md
similarity index 99%
rename from reference/canvas.md
rename to _reference/canvas.md
index e1d9812..b825ca1 100644
--- a/reference/canvas.md
+++ b/_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 b/_reference/menu.md
similarity index 99%
rename from reference/menu.md
rename to _reference/menu.md
index f29b271..b871e24 100644
--- a/reference/menu.md
+++ b/_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 b/_reference/navigation.md
similarity index 99%
rename from reference/navigation.md
rename to _reference/navigation.md
index d33dc71..591be82 100644
--- a/reference/navigation.md
+++ b/_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 b/_reference/panels.md
similarity index 99%
rename from reference/panels.md
rename to _reference/panels.md
index 5137ebe..da68931 100644
--- a/reference/panels.md
+++ b/_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 b/_reference/panels/designspace.md
similarity index 98%
rename from reference/panels/designspace.md
rename to _reference/panels/designspace.md
index b5136ba..a426896 100644
--- a/reference/panels/designspace.md
+++ b/_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 b/_reference/panels/find-glyph.md
similarity index 98%
rename from reference/panels/find-glyph.md
rename to _reference/panels/find-glyph.md
index 21a3f9e..1d17ca9 100644
--- a/reference/panels/find-glyph.md
+++ b/_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 b/_reference/panels/glyph-info.md
similarity index 98%
rename from reference/panels/glyph-info.md
rename to _reference/panels/glyph-info.md
index b625800..d01e726 100644
--- a/reference/panels/glyph-info.md
+++ b/_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 b/_reference/panels/options.md
similarity index 98%
rename from reference/panels/options.md
rename to _reference/panels/options.md
index f4d197f..d833a1a 100644
--- a/reference/panels/options.md
+++ b/_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 b/_reference/panels/preview-text.md
similarity index 98%
rename from reference/panels/preview-text.md
rename to _reference/panels/preview-text.md
index 12d1e76..fbbe672 100644
--- a/reference/panels/preview-text.md
+++ b/_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 b/_reference/panels/reference-font.md
similarity index 98%
rename from reference/panels/reference-font.md
rename to _reference/panels/reference-font.md
index 0a578dd..6c36046 100644
--- a/reference/panels/reference-font.md
+++ b/_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 b/_reference/reference.md
similarity index 98%
rename from reference/reference.md
rename to _reference/reference.md
index 8e31c8d..ae77973 100644
--- a/reference/reference.md
+++ b/_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 b/_reference/tools.md
similarity index 98%
rename from reference/tools.md
rename to _reference/tools.md
index 7059919..d22b568 100644
--- a/reference/tools.md
+++ b/_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 b/_reference/tools/hand.md
similarity index 97%
rename from reference/tools/hand.md
rename to _reference/tools/hand.md
index 1172bb5..4d7d4ac 100644
--- a/reference/tools/hand.md
+++ b/_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 b/_reference/tools/pen.md
similarity index 98%
rename from reference/tools/pen.md
rename to _reference/tools/pen.md
index ee23a6b..13d4fbf 100644
--- a/reference/tools/pen.md
+++ b/_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 b/_reference/tools/pointer.md
similarity index 99%
rename from reference/tools/pointer.md
rename to _reference/tools/pointer.md
index f8f1164..c8a6344 100644
--- a/reference/tools/pointer.md
+++ b/_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 b/_reference/tools/ruler.md
similarity index 98%
rename from reference/tools/ruler.md
rename to _reference/tools/ruler.md
index 62d6888..3b384db 100644
--- a/reference/tools/ruler.md
+++ b/_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 b/_reference/workspace.md
similarity index 98%
rename from reference/workspace.md
rename to _reference/workspace.md
index 253a7f3..99fab69 100644
--- a/reference/workspace.md
+++ b/_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 b/_tutorials/tutorials.md
similarity index 94%
rename from tutorials/tutorials.md
rename to _tutorials/tutorials.md
index 5514f40..911e34b 100644
--- a/tutorials/tutorials.md
+++ b/_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/tutorials/understanding-variable-components.md b/_tutorials/understanding-variable-components.md
similarity index 97%
rename from tutorials/understanding-variable-components.md
rename to _tutorials/understanding-variable-components.md
index 74a1d2f..715c320 100644
--- a/tutorials/understanding-variable-components.md
+++ b/_tutorials/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">