initial commit of series

config/_default/config.toml

@@ -18,6 +18,7 @@ buildFuture = false
   tag = "tags"
   category = "categories"
   author = "authors"
+  series = "series"
 
 [sitemap]
   changefreq = 'daily'

exampleSite/config/_default/config.toml

@@ -19,6 +19,7 @@ googleAnalytics = "G-PEDMYR1V0K"
   tag = "tags"
   category = "categories"
   author = "authors"
+  series = "series"
 
 [sitemap]
   changefreq = 'always'

exampleSite/content/docs/advanced-customisation/index.md

@@ -5,6 +5,8 @@ draft: false
 description: "Learn how to build Blowfish manually."
 slug: "advanced-customisation"
 tags: ["advanced", "css", "docs"]
+series: ["Docs"]
+series_order: 4
 ---
 
 There are many ways you can make advanced changes to Blowfish. Read below to learn more about what can be customised and the best way of achieving your desired result.

exampleSite/content/docs/configuration/index.md

@@ -5,6 +5,8 @@ draft: false
 description: "All the configuration variables available in Blowfish."
 slug: "configuration"
 tags: ["config", "docs"]
+series: ["Docs"]
+series_order: 2
 ---
 
 Blowfish is a highly customisable theme and uses some of the latest Hugo features to simplify how it is configured.

exampleSite/content/docs/getting-started/index.md

@@ -5,6 +5,8 @@ draft: false
 description: "All the front matter variables available in Blowfish."
 slug: "getting-started"
 tags: ["installation", "docs"]
+series: ["Docs"]
+series_order: 3
 ---
 
 {{< alert >}}

exampleSite/content/docs/welcome/index.md

@@ -4,6 +4,8 @@ date: 2022-01-19
 draft: false
 description: "Discover what's new in Blowfish version 2.0."
 tags: ["new", "docs"]
+series: ["Docs"]
+series_order: 1
 ---
 
 {{< lead >}}

layouts/_default/single.html

@@ -28,6 +28,7 @@
       </div>
       {{ end }}
       <div class="min-w-0 min-h-0 max-w-prose">
+        {{ partial "series.html" . }}
         {{ .Content | emojify }}
       </div>
       <script>

layouts/partials/series.html

@@ -0,0 +1,20 @@
+{{ if .Params.series }}
+<div>
+    <h4>This article is part of a series.</h4>
+    <ul class="list-group">
+        {{ range $post :=  sort (index .Site.Taxonomies.series (index .Params.series 0 | urlize)) "Params.series_order" }}
+        {{ if eq $post.Permalink $.Page.Permalink }}
+        <li class="list-group-item active">
+            Part {{ $post.Params.series_order }}: This Article
+        </li>
+        {{ else }}
+        <li class="list-group-item">
+            <a href="{{$post.Permalink}}">
+                Part {{ $post.Params.series_order }}: {{ $post.Params.title}}
+            </a>
+        </li>
+        {{end}}
+        {{end}}
+    </ul>
+</div>
+{{end}}