Commit 8d833bd9 authored by Henk Verlinde's avatar Henk Verlinde
Browse files

feat: add scroll spy to toc pages as an option (experimental)

parent 75d250b2

assets/scss/common/_dark.scss

+4 −0
Original line number Diff line number Diff line
@@ -570,3 +570,7 @@ $navbar-dark-active-color: $link-color-dark; 
[data-dark-mode] details summary::before {

  content: url("data:image/svg+xml,%3csvg xmlns='http://www.w3.org/2000/svg' width='14' height='14' viewBox='0 0 16 16'%3e%3cpath fill='none' stroke='rgba%28222, 226, 230, 0.75%29' stroke-linecap='round' stroke-linejoin='round' stroke-width='2' d='M5 14l6-6-6-6'/%3e%3c/svg%3e");

}



[data-dark-mode] #toc a.active {

  color: $link-color-dark;

}

assets/scss/common/_global.scss

+7 −1
Original line number Diff line number Diff line
@@ -214,11 +214,17 @@ body { 
  text-decoration: none;

}



#TableOfContents ul {

#TableOfContents ul,

#toc ul {

  padding-left: 0;

  list-style: none;

}



#toc a.active {

  color: $primary;

  font-weight: 500;

}



::selection {

  background: rgba(212, 53, 159, 0.2);

}

config/_default/params.toml

+1 −0
Original line number Diff line number Diff line
@@ -92,6 +92,7 @@ lastMod = false 
  docsVersioning = false

  fullWidth = false

  navbarSticky = true

  scrollSpy = true # experimental; needs Bootstrap >= 5.2.0-beta1



[menu]

  [menu.section]

layouts/_default/baseof.html

+1 −1
Original line number Diff line number Diff line
@@ -12,7 +12,7 @@ 
    {{ .Scratch.Set "class" .Type -}}

    {{ .Scratch.Add "class" " list" -}}

  {{ end -}}

  <body class="{{ .Scratch.Get "class" }}">

  <body class="{{ .Scratch.Get "class" }}"{{ if eq .Site.Params.options.scrollSpy true }} data-bs-spy="scroll" data-bs-target="#toc" data-bs-root-margin="0px 0px -90%" data-bs-smooth-scroll="true" tabindex="0"{{ end }}>

    {{ partial "header/header.html" . }}

    <div class="wrap container-{{ if .Site.Params.options.fullWidth }}fluid{{ else }}xxl{{ end }}" role="document">

      <div class="content">

layouts/partials/sidebar/docs-toc.html

+5 −1
Original line number Diff line number Diff line
@@ -17,6 +17,10 @@ 
</div>

<div class="page-links d-none d-xl-block">

  <h3>On this page</h3>

  {{ if eq .Site.Params.options.scrollSpy true -}}

    {{ .TableOfContents | replaceRE "<nav id=\"TableOfContents\">" "<nav id=\"toc\">" | safeHTML }}

  {{ else -}}

    {{ .TableOfContents }}

  {{ end -}}

</div>

{{ end -}}