Add series taxonomy (#258)

* Add series taxonomy
Thanks to @igor-baiborodine for this new feature!

README.md

@@ -224,6 +224,14 @@ The headings that are taken into account for a TOC are from _H2_ (##) to _H5_ (#
 {{< toc >}}
 ```
 
+### Series Taxonomy ###
+In case you want to group some articles as a series, you have to add the `series` front matter variable to each article and set its value to the name of the series, for example, `series: "My New Super Series"`.
+
+The page at `<site-base-url>/series/` will list all the series. To list all articles for a particular series within markdown, you can use the `series` shortcode with the series name in question, for instance: 
+```markdown
+{{< series "My New Super Series" >}}
+```
+
 ### Comments
 Currently [Commento](https://commento.io/) and [Disqus](https://disqus.com) are supported.
 

exampleSite/config.toml

@@ -146,6 +146,7 @@ disqusShortname = ""
   author   = "author"
   tag      = "tags"
   category = "categories"
+  series   = "series"
 
 [outputs]
   home = [ "HTML", "JSON", "RSS" ]

i18n/en.toml

@@ -38,3 +38,5 @@ other = "{{.Count}} min read"
 [tableOfContents]
 other = "Table of Contents"
 
+[series]
+other = "Series"

layouts/_default/series.terms.html

@@ -0,0 +1,30 @@
+{{ define "main" }}
+
+<div class="content">
+    <div class="article-wrapper u-cf single">
+        <a class="bubble" href="{{ "/series/" | relLangURL}}">
+            <i class="fa fa-fw fa-list-alt"></i>
+        </a>
+
+        <article class="article">
+            <div class="content">
+                <h3>{{ i18n "series" | default "series" }}</h3>
+                <hr>
+                <ul id="all-series">
+                    {{ range $name, $taxonomy := .Site.Taxonomies.series }}
+                        {{ $series_name := $name }}
+                        {{ $series_path := (printf "/series/%s" (urlize $name)) }}
+                        {{ $series_page := site.GetPage $series_path }}
+
+                        {{ if $series_page }}
+                            {{ $series_name = $series_page.Title }}
+                        {{ end }}
+
+                        <li><a href="{{ $series_path }}">{{ $series_name }} ({{ $taxonomy.Count }})</a></li>
+                    {{ end }}
+                </ul>
+            </div>
+        </article>
+    </div>
+</div>
+{{ end }}

layouts/index.json

@@ -18,6 +18,10 @@
     {{- $.Scratch.Add "index" (dict "url" (print "/tags/" $name | absURL) "title" ($name | humanize) "iconClass" "fa-tag" "type" "tag" "objectID" (print "/tags/" $name | absURL) ) -}}
 {{- end -}}
 
+{{- range $name, $taxonomy := .Site.Taxonomies.series -}}
+    {{- $.Scratch.Add "index" (dict "url" (print "/series/" $name | absURL) "title" ($name | humanize) "iconClass" "fa-list-alt" "type" "series" "objectID" (print "/series/" $name | absURL) ) -}}
+{{- end -}}
+
 {{- range where .Site.RegularPages "Type" "not in" (slice "page" "json" "status") -}}
     {{- $iconClass := "" -}}
     {{- if and (isset .Params "icon") (ne .Params.icon "") -}}

layouts/shortcodes/series.html

@@ -0,0 +1,11 @@
+{{ $series_name := .Get 0 | urlize }}
+
+{{ range $key, $taxonomy := .Site.Taxonomies.series }}
+    {{ if eq $key $series_name }}
+    <ul>
+        {{ range $taxonomy.Pages.ByDate }}
+        <li hugo-nav="{{ .RelPermalink }}"><a href="{{ .Permalink }}">{{ .LinkTitle }}</a></li>
+        {{ end }}
+    </ul>
+    {{ end }}
+{{ end }}

testing/testing-example-site/config.toml

@@ -143,6 +143,7 @@ disqusShortname = "bilberry-hugo-theme"
   author   = "author"
   tag      = "tags"
   category = "categories"
+  series   = "series"
 
 [outputs]
   home = [ "HTML", "JSON", "RSS" ]