Updates generating right-hand toc to use tocbot

Author: fekete-robert

assets/scss/_tocbot.scss

@@ -0,0 +1,5 @@
+// Used to customize right-hand sidebar when using Tocbot
+// Override active link color
+.is-active-link::before {
+	background-color: $primary !important;
+}

assets/scss/main.scss

@@ -36,7 +36,7 @@
 @import "shortcodes";
 @import "swagger";
 @import "support/rtl";
-
+@import "tocbot";
 
 @if $td-enable-google-fonts {
   @import url($web-font-path);

layouts/_partials/scripts.html

@@ -74,6 +74,11 @@
   {{ template "algolia/scripts" .Site.Params.search.algolia -}}
 {{ end -}}
 <script src='{{ "js/tabpane-persist.js" | relURL }}'></script>
+
+{{ if .Site.Params.jstoc.enable -}}
+{{- partial "scripts/jstoc.html" . -}}
+{{ end -}}
+
 {{ partial "hooks/body-end.html" . -}}
 
 {{ define "algolia/scripts" -}}

layouts/_partials/scripts/jstoc.html

@@ -0,0 +1,45 @@
+{{ $version := .Site.Params.jstoc.version | default "4.34.0" -}}
+{{ $hash := .Site.Params.jstoc.hash | default "sha512-EMZRx2Hno6csUwgZoOMjyKDp1UdNRrCQH0R97VEPYynqgSUrRItJn73HnRUwqujCat2/Zg731UEw+7xDXAL1ag==" -}}
+{{ $css_hash := .Site.Params.jstoc.css_hash | default "sha512-4q0OX9NAYcRTFEfy9nTK0AV9N7MxM665neDXEW3CjAj1pXc6+8Bcd6ryXl6cY8mTBBXt0aXepnSDLLQZSuJRww==" -}}
+{{ $css_url := printf "https://cdnjs.cloudflare.com/ajax/libs/tocbot/%s/tocbot.min.css" $version -}}
+{{ $cdn_url := printf "https://cdnjs.cloudflare.com/ajax/libs/tocbot/%s/tocbot.min.js" $version -}}
+
+{{ with try (resources.GetRemote $css_url) -}}
+  {{ with .Err -}}
+    {{ errorf "Could not retrieve Tocbot css file from CDN. Reason: %s." . -}}
+  {{ else with.Value -}}
+    {{ with resources.Copy (printf "css/tocbot.min.css" ) . }}
+      {{ $secureCSS := . | resources.Fingerprint "sha512" -}}
+<link rel="stylesheet" href="{{- .RelPermalink -}}" integrity="{{- $secureCSS.Data.Integrity -}}" crossorigin="anonymous" referrerpolicy="no-referrer">
+    {{ end -}}
+  {{ end -}}
+{{ else -}}
+  {{ errorf "Invalid Tocbot version %s, could not retrieve this version from CDN." $version -}}
+{{ end -}}
+
+{{ with try (resources.GetRemote $cdn_url) -}}
+  {{ with .Err -}}
+    {{ errorf "Could not retrieve Tocbot script from CDN. Reason: %s." . -}}
+  {{ else with.Value -}}
+    {{ with resources.Copy (printf "js/tocbot.min.js" ) . }}
+      {{ $secureJS := . | resources.Fingerprint "sha512" -}}
+<script src="{{- .RelPermalink -}}" integrity="{{- $secureJS.Data.Integrity -}}" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
+    {{ end -}}
+  {{ end -}}
+{{ else -}}
+  {{ errorf "Invalid Tocbot version %s, could not retrieve this version from CDN." $version -}}
+{{ end -}}
+
+<!-- Initialize tocbot -->
+<script type="text/javascript">
+    tocbot.init({
+        // Where to render the table of contents.
+        tocSelector: '.td-toc',
+        // Where to grab the headings to build the table of contents.
+        contentSelector: '.td-content',
+        // Which headings to grab inside of the contentSelector element.
+        headingSelector: '{{ with .Site.Params.jstoc.custom_headings }}{{ . }}{{ else }}h2, h3, h4{{ end }}',
+        // ignore headings that are hidden in DOM
+        ignoreHiddenElements: true
+    });
+</script>

userguide/content/en/docs/adding-content/lookandfeel.md

@@ -555,3 +555,29 @@ feature of Hugo in your configuration file, or in the front matter of the
 highest-level page you want to modify.
 
 [bs-docs]: https://getbootstrap.com/docs/
+
+## Sidebar table of contents
+
+By default, Docsy shows the table of contents for the current page in the right sidebar using the built-in function of Hugo. You can replace that with a JavaScript-based ToC that uses the [https://tscanlin.github.io/tocbot/](Tocbot library) by setting the following in your `config.toml` file:
+
+```toml
+[params.jstoc]
+enable = true
+```
+
+By default, h2-h4 headings are included in the sidebar, which includes tips and warnings if you are using the [alert shortcode of Docsy](/docs/adding-content/shortcodes/#alert). To change that,
+provide a comma-separated list of the headings to include in the `custom_headings` parameter, for example:
+
+```toml
+[params.jstoc]
+enable = true
+custom_headings = "h2, h3"
+```
+
+Compared to the default sidebar ToC, this solution:
+
+- has a marker that shows the current location of the screen (useful for long pages)
+- shows the correct title even if the title contains a shortcode
+- shows the title in the toc even if it was included from another file
+
+![Screenshot of JavaScript-based sidebar table of contents](/images/sidebar-toc-with-tocbot.png)