Merge pull request #637 from h-enk/new-docs-tree

Adds new docs tree — with a single command 🤖

archetypes/blog.md

@@ -9,5 +9,3 @@ weight: 50
 images: ["{{ .Name | urlize }}.jpg"]
 contributors: []
 ---
-
-{{< img src="{{ .Name | urlize }}.jpg" alt="{{ replace .Name "-" " " | title }}" caption="{{ replace .Name "-" " " | title }}" class="wide" >}}

archetypes/docs.md

@@ -6,11 +6,9 @@ date: {{ .Date }}
 lastmod: {{ .Date }}
 draft: true
 images: []
-menu: 
+menu:
   docs:
     parent: ""
 weight: 999
 toc: true
 ---
-
-{{< img src="{{ .Name | urlize }}.jpg" alt="{{ replace .Name "-" " " | title }}" caption="{{ replace .Name "-" " " | title }}" >}}

archetypes/docs/_index.md

@@ -1,8 +1,10 @@
 ---
-title: "Tutorial"
+title: "Docs"
 description: ""
+lead: ""
 date: 2022-01-25T14:40:56+01:00
 lastmod: 2022-01-25T14:40:56+01:00
 draft: false
 images: []
+type: docs
 ---

archetypes/docs/lorem/_index.md

@@ -1,8 +1,10 @@
 ---
 title: "Lorem"
 description: ""
+lead: ""
 date: 2022-01-25T14:41:21+01:00
 lastmod: 2022-01-25T14:41:21+01:00
 draft: false
 images: []
+type: docs
 ---

archetypes/docs/lorem/ipsum/index.md

@@ -1,8 +1,15 @@
 ---
 title: "Ipsum"
 description: ""
+lead: ""
 date: 2022-01-25T14:41:39+01:00
 lastmod: 2022-01-25T14:41:39+01:00
 draft: false
 images: []
+type: docs
+menu:
+  {{ .Section }}:
+    parent: "lorem"
+weight: 100
+toc: true
 ---

config/_default/menus/menus.en.toml

@@ -10,11 +10,23 @@
   identifier = "help"
   url = "/docs/help/"
 
-[[docs]]
+# [[docs]]
+#   name = "Lorem"
+#   weight = 70
+#   identifier = "lorem"
+#   url = "/docs/lorem/"
+
+[[guide]]
   name = "Lorem"
-  weight = 70
+  weight = 10
   identifier = "lorem"
-  url = "/docs/lorem/"
+  url = "/guide/lorem/"
+
+[[tutorial]]
+  name = "Lorem"
+  weight = 10
+  identifier = "lorem"
+  url = "/tutorial/lorem/"
 
 [[main]]
   name = "Docs"
@@ -22,6 +34,11 @@
 # url = "/docs/1.0/prologue/introduction/"
   weight = 10
 
+# [[main]]
+#   name = "Tutorial"
+#   url = "/tutorial/lorem/ipsum/"
+#   weight = 15
+
 [[main]]
   name = "Blog"
   url = "/blog/"

config/_default/params.toml

@@ -92,4 +92,3 @@ lastMod = false
   [menu.section]
     auto = true
     collapsibleSidebar = true
-    mainSections = ["docs"]

layouts/docs/list.html

@@ -2,7 +2,7 @@
 <div class="row justify-content-center">
   <div class="col-md-12 col-lg-10 col-xl-8">
     <article>
-      <h1 class="text-center">{{ .Title }}</h1>
+      <h1 class="text-center">{{ if eq .CurrentSection .FirstSection }}{{ .Section | humanize }}{{ else }}{{ .Title }}{{ end }}</h1>
       <div class="text-center">{{ .Content }}</div>
 			<div class="card-list">
 				{{ $currentSection := .CurrentSection }}

layouts/partials/header/header.html

@@ -28,11 +28,12 @@
         <h3 class="h6 text-uppercase mb-3 d-md-none">Main</h3>
         <ul class="nav flex-column flex-md-row ms-md-n3">
           {{- $current := . -}}
+          {{- $section := $current.Section -}}
           {{ range .Site.Menus.main -}}
             {{- $active := or ($current.IsMenuCurrent "main" .) ($current.HasMenuCurrent "main" .) -}}
             {{- $active = or $active (eq .Name $current.Title) -}}
-            {{- $active = or $active (and (eq .Name "Docs") (eq $current.Section "docs")) -}}
+            {{- $active = or $active (and (eq .Name ($section | humanize)) (eq $current.Section $section)) -}}
-            {{- $active = or $active (and (eq .Name "Blog") (eq $current.Section "blog" "authors")) -}}
+            {{- $active = or $active (and (eq .Name "Blog") (eq $current.Section "blog" "contributors")) -}}
             <li class="nav-item">
               <a class="nav-link ps-0 py-1{{ if $active }} active{{ end }}" href="{{ .URL | relLangURL }}">{{ .Name }}</a>
             </li>
@@ -128,6 +129,25 @@
   </div>
 </nav>
 
+<div class="container-{{ if .Site.Params.options.fullWidth }}fluid{{ else }}xxl{{ end }}">
+  <aside class="doks-sidebar">
+    <nav id="doks-docs-nav" class="collapse d-lg-none" aria-label="Tertiary navigation">
+      {{ partial "sidebar/docs-menu.html" . }}
+    </nav>
+  </aside>
+</div>
+
+{{ else -}}
+<nav class="doks-subnavbar py-2 sticky-lg-top d-lg-none" aria-label="Secondary navigation">
+  <div class="container-{{ if .Site.Params.options.fullWidth }}fluid{{ else }}xxl{{ end }} d-flex align-items-md-center">
+    <span class="navbar-text ms-0">{{ .Section | humanize }}</span>
+    <button class="btn doks-sidebar-toggle d-lg-none ms-auto order-3 collapsed" type="button" data-bs-toggle="collapse" data-bs-target="#doks-docs-nav" aria-controls="doks-docs-nav" aria-expanded="false" aria-label="Toggle documentation navigation">
+      <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" class="doks doks-expand" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><title>Expand</title><polyline points="7 13 12 18 17 13"></polyline><polyline points="7 6 12 11 17 6"></polyline></svg>
+      <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" class="doks doks-collapse" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"><title>Collapse</title><polyline points="17 11 12 6 7 11"></polyline><polyline points="17 18 12 13 7 18"></polyline></svg>
+    </button>
+  </div>
+</nav>
+
 <div class="container-{{ if .Site.Params.options.fullWidth }}fluid{{ else }}xxl{{ end }}">
   <aside class="doks-sidebar">
     <nav id="doks-docs-nav" class="collapse d-lg-none" aria-label="Tertiary navigation">

layouts/partials/main/breadcrumb.html

@@ -1,4 +1,4 @@
 {{ with .Parent -}}
   {{ partial "main/breadcrumb.html" . -}}
-  <li class="breadcrumb-item"><a href="{{ .RelPermalink }}">{{ if .IsHome }}Home{{ else }}{{ .Title }}{{ end }}</a></li>
+  <li class="breadcrumb-item"><a href="{{ .RelPermalink }}">{{ if .IsHome }}Home{{ else if eq .CurrentSection .FirstSection }}{{ .Section | humanize }}{{ else }}{{ .Title }}{{ end }}</a></li>
 {{ end -}}

layouts/partials/sidebar/auto-collapsible-menu.html

@@ -1,7 +1,8 @@
 <!-- Auto collapsible section menu -->
 <ul class="list-unstyled collapsible-sidebar">
   {{ $currentPage := . -}}
-  {{ range (where .Site.Sections "Section" "in" site.Params.menu.section.mainSections) }}
+  {{ $section := $currentPage.Section -}}
+  {{ range (where .Site.Sections "Section" "in" $section) }}
     {{ range .Sections.Reverse }}
       {{ $active := in $currentPage.RelPermalink .RelPermalink }}
       <li class="mb-1">

layouts/partials/sidebar/auto-default-menu.html

@@ -1,6 +1,7 @@
 <!-- Auto default section menu -->
 {{ $currentPage := . -}}
-{{ range (where .Site.Sections "Section" "in" site.Params.menu.section.mainSections) }}
+{{ $section := $currentPage.Section -}}
+{{ range (where .Site.Sections "Section" "in" $section) }}
   {{ range .Sections.Reverse }}
     {{ $active := in $currentPage.RelPermalink .RelPermalink }}
     <h3 class="h6 text-uppercase mb-2">{{ .Title }}</h3>

layouts/partials/sidebar/manual-collapsible-menu.html

@@ -1,8 +1,9 @@
 <!-- Manual collapsible section menu -->
 <ul class="list-unstyled collapsible-sidebar">
   {{ $currentPage := . -}}
-  {{ range $index, $element := .Site.Menus.docs -}}
+  {{ $section := $currentPage.Section -}}
-    {{- $active := or ($currentPage.IsMenuCurrent "docs" .) ($currentPage.HasMenuCurrent "docs" .) -}}
+  {{ range (index .Site.Menus $section) -}}
+    {{- $active := or ($currentPage.IsMenuCurrent $section .) ($currentPage.HasMenuCurrent $section .) -}}
     {{- $active = or $active (eq $currentPage.Section .Identifier) -}}
     <li class="mb-1">
       <button class="btn btn-toggle align-items-center rounded collapsed" data-bs-toggle="collapse" data-bs-target="#section-{{ .Identifier }}" aria-expanded="{{ if $active }}true{{ else }}false{{ end }}">
@@ -30,7 +31,7 @@
                                 <div class="collapse{{ if $active }} show{{ end }}" id="section-{{ .Identifier }}">
                                   <ul class="btn-toggle-nav list-unstyled fw-normal pb-1 small">
                                   {{ range .Children -}}
-                                    {{- $active := or ($currentPage.IsMenuCurrent "docs" .) ($currentPage.HasMenuCurrent "docs" .) -}}
+                                    {{- $active := or ($currentPage.IsMenuCurrent $section .) ($currentPage.HasMenuCurrent $section .) -}}
                                     {{- $active = or $active (eq $currentPage.Section .Identifier) -}}
                                     <li><a class="docs-link rounded{{ if $active }} active{{ end }}" href="{{ .URL | relURL }}">{{ .Name }}</a></li>
                                   {{ end -}}
@@ -39,7 +40,7 @@
                               {{ end -}}
                             </li>
                           {{ else -}}
-                            {{- $active := or ($currentPage.IsMenuCurrent "docs" .) ($currentPage.HasMenuCurrent "docs" .) -}}
+                            {{- $active := or ($currentPage.IsMenuCurrent $section .) ($currentPage.HasMenuCurrent $section .) -}}
                             {{- $active = or $active (eq $currentPage.Section .Identifier) -}}
                             <li><a class="docs-link rounded{{ if $active }} active{{ end }}" href="{{ .URL | relURL }}">{{ .Name }}</a></li>
                           {{ end -}}
@@ -49,7 +50,7 @@
                   {{ end -}}
                 </li>
               {{ else -}}
-                {{- $active := or ($currentPage.IsMenuCurrent "docs" .) ($currentPage.HasMenuCurrent "docs" .) -}}
+                {{- $active := or ($currentPage.IsMenuCurrent $section .) ($currentPage.HasMenuCurrent $section .) -}}
                 {{- $active = or $active (eq $currentPage.Section .Identifier) -}}
                 <li><a class="docs-link rounded{{ if $active }} active{{ end }}" href="{{ .URL | relURL }}">{{ .Name }}</a></li>
               {{ end -}}

layouts/partials/sidebar/manual-default-menu.html

@@ -1,6 +1,7 @@
 <!-- Manual default section menu -->
 {{ $currentPage := . -}}
-{{ range .Site.Menus.docs -}}
+{{ $section := $currentPage.Section -}}
+{{ range (index .Site.Menus $section) -}}
   <h3 class="h6 text-uppercase mb-2">{{ .Name }}</h3>
   {{ if .HasChildren -}}
     <ul class="list-unstyled">
@@ -15,14 +16,14 @@
                   {{ if .HasChildren -}}
                     <ul class="list-unstyled ms-3">
                       {{ range .Children -}}
-                        {{- $active := or ($currentPage.IsMenuCurrent "docs" .) ($currentPage.HasMenuCurrent "docs" .) -}}
+                        {{- $active := or ($currentPage.IsMenuCurrent $section .) ($currentPage.HasMenuCurrent $section .) -}}
                         {{- $active = or $active (eq $currentPage.Section .Identifier) -}}
                         <li><a class="docs-link{{ if $active }} active{{ end }}" href="{{ .URL | relURL }}">{{ .Name }}</a></li>
                       {{ end -}}
                     </ul>
                   {{ end -}}
                 {{ else -}}
-                  {{- $active := or ($currentPage.IsMenuCurrent "docs" .) ($currentPage.HasMenuCurrent "docs" .) -}}
+                  {{- $active := or ($currentPage.IsMenuCurrent $section .) ($currentPage.HasMenuCurrent $section .) -}}
                   {{- $active = or $active (eq $currentPage.Section .Identifier) -}}
                   <li><a class="docs-link{{ if $active }} active{{ end }}" href="{{ .URL | relURL }}">{{ .Name }}</a></li>
                 {{ end -}}
@@ -30,7 +31,7 @@
             </ul>
           {{ end -}}
         {{ else -}}
-          {{- $active := or ($currentPage.IsMenuCurrent "docs" .) ($currentPage.HasMenuCurrent "docs" .) -}}
+          {{- $active := or ($currentPage.IsMenuCurrent $section .) ($currentPage.HasMenuCurrent $section .) -}}
           {{- $active = or $active (eq $currentPage.Section .Identifier) -}}
           <li><a class="docs-link{{ if $active }} active{{ end }}" href="{{ .URL | relURL }}">{{ .Name }}</a></li>
         {{ end -}}