From 0b9cbc41506732ff44b656bf58d90f1c4f4a7ab4 Mon Sep 17 00:00:00 2001
From: George Cushen <gcushen@users.noreply.github.com>
Date: Sat, 25 Jul 2020 01:47:37 +0100
Subject: [PATCH] feat: add Book layout

Similar to the Docs layout but much easier to use.

Add `type: book` to a page's front matter and place Markdown files within a folder hierarchy to automatically create the book sidebar navigation.

Introduces {{< list_children >}} shortcode for listing children of a book chapter.
---
 layouts/book/list.html                |  3 +
 layouts/book/single.html              |  3 +
 layouts/partials/book_layout.html     | 59 +++++++++++++++++++
 layouts/partials/book_menu.html       | 83 +++++++++++++++++++++++++++
 layouts/partials/book_sidebar.html    | 28 +++++++++
 layouts/partials/section_pager.html   |  6 +-
 layouts/partials/site_footer.html     |  2 +-
 layouts/shortcodes/list_children.html |  7 +++
 8 files changed, 187 insertions(+), 4 deletions(-)
 create mode 100644 layouts/book/list.html
 create mode 100644 layouts/book/single.html
 create mode 100644 layouts/partials/book_layout.html
 create mode 100644 layouts/partials/book_menu.html
 create mode 100644 layouts/partials/book_sidebar.html
 create mode 100644 layouts/shortcodes/list_children.html

diff --git a/layouts/book/list.html b/layouts/book/list.html
new file mode 100644
index 00000000..1e1fe909
--- /dev/null
+++ b/layouts/book/list.html
@@ -0,0 +1,3 @@
+{{- define "main" -}}
+{{ partial "book_layout.html" . }}
+{{- end -}}
diff --git a/layouts/book/single.html b/layouts/book/single.html
new file mode 100644
index 00000000..1e1fe909
--- /dev/null
+++ b/layouts/book/single.html
@@ -0,0 +1,3 @@
+{{- define "main" -}}
+{{ partial "book_layout.html" . }}
+{{- end -}}
diff --git a/layouts/partials/book_layout.html b/layouts/partials/book_layout.html
new file mode 100644
index 00000000..9ca6100a
--- /dev/null
+++ b/layouts/partials/book_layout.html
@@ -0,0 +1,59 @@
+{{ $current_page := . }}
+
+<div class="container-fluid docs">
+  <div class="row flex-xl-nowrap">
+    <div class="col-12 col-md-3 col-xl-2 docs-sidebar">
+      {{ partial "book_sidebar" . }}
+    </div>
+
+    {{/* Show ToC by default. */}}
+    {{ if ne .Params.toc false }}
+    <div class="d-none d-xl-block col-xl-2 docs-toc">
+      <ul class="nav toc-top">
+        <li><a href="#" id="back_to_top" class="docs-toc-title">{{ i18n "on_this_page" }}</a></li>
+      </ul>
+
+      {{ .TableOfContents }}
+
+      {{ partial "docs_toc_foot" . }}
+    </div>
+    {{ end }}
+
+    <main class="col-12 col-md-9 col-xl-8 py-md-3 pl-md-5 docs-content" role="main">
+
+      <article class="article">
+
+        <div class="docs-article-container">
+          <h1>{{ .Title }}</h1>
+
+          <div class="article-style">
+            {{ .Content }}
+          </div>
+
+          {{ partial "tags.html" . }}
+
+          {{/* Show next/previous pages by default. */}}
+          {{ if ne site.Params.book_section_pager false }}
+          <div class="article-widget">
+            {{ partial "section_pager" . }}
+          </div>
+          {{ end }}
+        </div>
+
+        <div class="body-footer">
+          <p>{{ i18n "last_updated" }} {{ $.Lastmod.Format site.Params.date_format }}</p>
+
+          {{ partial "page_edit" . }}
+
+          {{ partial "comments" . }}
+
+          {{ partial "page_related" . }}
+        </div>
+
+      </article>
+
+      {{ partial "site_footer" . }}
+
+    </main>
+  </div>
+</div>
diff --git a/layouts/partials/book_menu.html b/layouts/partials/book_menu.html
new file mode 100644
index 00000000..0d58f8f5
--- /dev/null
+++ b/layouts/partials/book_menu.html
@@ -0,0 +1,83 @@
+{{ define "book-menu" }}
+
+{{- $first := false -}}
+{{- $current_node := .current_node -}}
+{{- $order_by := .order_by -}}
+{{ $icon := "" }}
+
+{{ with .sect }}
+  {{ if .IsSection}}
+    {{- $first = eq $current_node.FirstSection . -}}
+
+    {{- safeHTML $current_node.FirstSection.Params.pre_nav -}}
+
+    {{/* Get section icon. */}}
+    {{ $pack := or .Params.icon_pack "fas" }}
+    {{ $pack_prefix := $pack }}
+    {{ if in (slice "fab" "fas" "far" "fal") $pack }}
+      {{ $pack_prefix = "fa" }}
+    {{ end }}
+    {{ with .Params.icon }}
+      {{- if eq $pack "emoji" -}}
+        {{- . | emojify -}}
+      {{- else if eq $pack "custom" -}}
+        {{- $svg_icon := resources.Get (printf "images/icon-pack/%s.svg" .) -}}
+        {{- if $svg_icon -}}
+          {{ $icon = printf "<img src=\"%s\" alt=\"%s\" class=\"svg-icon svg-baseline pr-1\">" $svg_icon.RelPermalink . }}
+        {{- end -}}
+      {{- else -}}
+        {{ $icon = printf "<i class=\"%s %s-%s pr-1\"></i>" $pack $pack_prefix . }}
+      {{- end -}}
+    {{ end }}
+
+    {{ if $first }}
+      <ul class="nav docs-sidenav">
+        <li class="{{ if and .File $current_node.File | and (eq .File.UniqueID $current_node.File.UniqueID) }}active{{ end }}"><a href="{{ .RelPermalink }}">{{ safeHTML $icon }}{{ .LinkTitle | default .Title }}</a></li>
+    {{else}}
+      <div class="docs-toc-item">
+        <a class="docs-toc-link {{ if and .File $current_node.File | and (eq .File.UniqueID $current_node.File.UniqueID) }} active{{ end }}" href="{{ .RelPermalink }}">{{ safeHTML $icon }}{{ .LinkTitle | default .Title }}</a>
+    {{end}}
+
+    {{- $page_count := (add (len .Pages) (len .Sections)) -}}
+    {{ if ne $page_count 0 }}
+      {{ if not $first }}
+        <ul class="nav docs-sidenav">
+      {{end}}
+      {{- .Scratch.Set "pages" .Pages -}}
+      {{- if .Sections -}}
+        {{- .Scratch.Set "pages" (.Pages | union .Sections) -}}
+      {{- end -}}
+      {{- $pages := (.Scratch.Get "pages") -}}
+      {{- if eq $order_by "title" -}}
+        {{- range $pages.ByTitle -}}
+          {{ template "book-menu" dict "sect" . "current_node" $current_node "order_by" $order_by }}
+        {{- end -}}
+      {{- else if eq $order_by "title_desc" -}}
+        {{- range $pages.ByTitle.Reverse -}}
+          {{ template "book-menu" dict "sect" . "current_node" $current_node "order_by" $order_by }}
+        {{- end -}}
+      {{- else -}}
+        {{- range $pages.ByWeight -}}
+          {{ template "book-menu" dict "sect" . "current_node" $current_node "order_by" $order_by }}
+        {{- end -}}
+      {{- end}}
+      {{ if not $first }}
+        </ul>
+      {{end}}
+    {{end}}
+
+    {{ if not $first }}
+      </div>
+    {{else}}
+      </ul>
+    {{end}}
+
+  {{- else -}}
+    {{- if not .Params.Hidden -}}
+      <li class="{{ if and .File $current_node.File | and (eq .File.UniqueID $current_node.File.UniqueID) }}active{{ end }}"><a href="{{ .RelPermalink }}">{{ safeHTML $icon }}{{ .LinkTitle | default .Title }}</a></li>
+    {{- end -}}
+  {{ end -}}
+{{- end -}}
+
+{{/* End define. */}}
+{{ end -}}
diff --git a/layouts/partials/book_sidebar.html b/layouts/partials/book_sidebar.html
new file mode 100644
index 00000000..6e33b406
--- /dev/null
+++ b/layouts/partials/book_sidebar.html
@@ -0,0 +1,28 @@
+<form class="docs-search d-flex align-items-center">
+  <button class="btn docs-toggle d-md-none p-0 mr-3" type="button" data-toggle="collapse" data-target="#docs-nav" aria-controls="docs-nav" aria-expanded="false" aria-label="Toggle section navigation">
+    <span><i class="fas fa-bars"></i></span>
+  </button>
+
+  {{ if eq site.Params.search.engine 1 }}
+  <input name="q" type="search" class="form-control" placeholder="{{ i18n "search_placeholder" }}" autocomplete="off">
+  {{ end }}
+</form>
+
+<nav class="collapse docs-links" id="docs-nav">
+  {{ $current_node := . }}
+  {{ $menu_name := (path.Base (path.Split .FirstSection).Dir) }}
+  {{ $order_by := cond (eq $menu_name "updates") "title_desc" site.Params.books.order_by }}
+
+  {{ $query := "" }}
+  {{- if eq $order_by "title" -}}
+    {{- $query = where .Site.Home.Sections.ByTitle "Section" $menu_name -}}
+  {{- else if eq $order_by "title_desc" -}}
+    {{- $query = where .Site.Home.Sections.ByTitle.Reverse "Section" $menu_name -}}
+  {{- else -}}
+    {{- $query = where .Site.Home.Sections.ByWeight "Section" $menu_name -}}
+  {{- end}}
+
+  {{- range $query -}}
+    {{ template "book-menu" dict "sect" . "current_node" $current_node "order_by" $order_by }}
+  {{- end -}}
+</nav>
diff --git a/layouts/partials/section_pager.html b/layouts/partials/section_pager.html
index 3f082d6f..a22d9c77 100644
--- a/layouts/partials/section_pager.html
+++ b/layouts/partials/section_pager.html
@@ -1,15 +1,15 @@
 {{ $str := "" }}
 <div class="post-nav">
   {{if .NextInSection}}
-  {{/* For the docs layout, prev/next labels are reversed. */}}
-  {{ if eq .Type "docs" }}{{ $str = "previous" }}{{else}}{{ $str = "next" }}{{end}}
+  {{/* For the Book layout, prev/next labels are reversed. */}}
+  {{ if in .Type (dict "docs" "book") }}{{ $str = "previous" }}{{else}}{{ $str = "next" }}{{end}}
   <div class="post-nav-item">
     <div class="meta-nav">{{ i18n $str }}</div>
     <a href="{{.NextInSection.RelPermalink}}" rel="next">{{.NextInSection.Title}}</a>
   </div>
   {{end}}
   {{if .PrevInSection}}
-  {{ if eq .Type "docs" }}{{ $str = "next" }}{{else}}{{ $str = "previous" }}{{end}}
+  {{ if in .Type (dict "docs" "book") }}{{ $str = "next" }}{{else}}{{ $str = "previous" }}{{end}}
   <div class="post-nav-item">
     <div class="meta-nav">{{ i18n $str }}</div>
     <a href="{{.PrevInSection.RelPermalink}}" rel="prev">{{.PrevInSection.Title}}</a>
diff --git a/layouts/partials/site_footer.html b/layouts/partials/site_footer.html
index 25875bf3..dac7fb50 100644
--- a/layouts/partials/site_footer.html
+++ b/layouts/partials/site_footer.html
@@ -23,7 +23,7 @@
     <a href="https://sourcethemes.com/academic/" target="_blank" rel="noopener">Academic theme</a> for
     <a href="https://gohugo.io" target="_blank" rel="noopener">Hugo</a>.
 
-    {{ if not (in (slice "docs" "updates") .Type) }}
+    {{ if not (in (slice "book" "docs" "updates") .Type) }}
     <span class="float-right" aria-hidden="true">
       <a href="#" class="back-to-top">
         <span class="button_icon">
diff --git a/layouts/shortcodes/list_children.html b/layouts/shortcodes/list_children.html
new file mode 100644
index 00000000..de3e6eef
--- /dev/null
+++ b/layouts/shortcodes/list_children.html
@@ -0,0 +1,7 @@
+{{ if gt (len $.Page.Pages) 0}}
+  <ul class="list-unstyled">
+    {{ range $.Page.Pages }}
+      <li><h5><a href="{{.RelPermalink}}">{{.LinkTitle}}</a></h5> {{with .Params.summary}}<p>{{. | plainify | emojify}}</p>{{end}}</li>
+    {{end}}
+  </ul>
+{{end}}