Skip to content

Add support for BS ScrollSpy to show active TOC entry #2287

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 13, 2025
Merged

Add support for BS ScrollSpy to show active TOC entry #2287

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d9a011c
Add support for BS ScrollSpy to show active TOC entry
chalin Jun 13, 2025
a12acc1
Update _sidebar-toc.scss: use SCSS var
chalin Jun 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 36 additions & 5 deletions assets/scss/_sidebar-toc.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,11 @@
}

.td-toc {
$toc-padding-base: 1rem;
$toc-padding-increment: 0.5rem; // for TOC entry nesting

margin-top: 1rem;

a {
display: block;
font-weight: $font-weight-light;
Expand All @@ -36,23 +41,49 @@
display: block;
}

li li {
margin-left: 0.5rem;
> .toc-title {
font-weight: $font-weight-bold;
color: var(--bs-secondary-color);
border-bottom: 1px solid var(--bs-tertiary-color);
padding-bottom: 0.5rem;
margin-bottom: 0.5rem;
}

#TableOfContents {
// Hugo's ToC is a mouthful, this can be used to style the top level h2 entries.
> ul > li > ul > li > a {
}
margin-left: -0.75rem;

a {
margin-left: 0;
padding-left: $toc-padding-base;
text-decoration: none;
border-left: .125rem solid transparent;
transition: color 0.15s ease-in-out, border-color 0.15s ease-in-out;
color: var(--bs-secondary-color);

&.active {
color: var(--bs-primary);
border-left-color: var(--bs-primary);
font-weight: $font-weight-medium;
}

&:focus,
&:hover {
color: initial;
}
}

ul ul a {
padding-left: $toc-padding-base + $toc-padding-increment;
}
ul ul ul a {
padding-left: $toc-padding-base + ($toc-padding-increment * 2);
}
ul ul ul ul a {
padding-left: $toc-padding-base + ($toc-padding-increment * 3);
}
ul ul ul ul ul a {
padding-left: $toc-padding-base + ($toc-padding-increment * 4);
}
}

ul {
Expand Down
4 changes: 4 additions & 0 deletions layouts/_partials/td/scroll-spy-attr.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
data-bs-spy="scroll" {{/**/ -}}
data-bs-target="#TableOfContents" {{/**/ -}}
data-bs-smooth-scroll="true" {{/**/ -}}
data-bs-root-margin="0px 0px -40%" {{/**/ -}}
1 change: 1 addition & 0 deletions layouts/_partials/toc.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
{{ with .TableOfContents -}}
{{ if ne . `<nav id="TableOfContents"></nav>` -}}
<div class="td-toc">
<div class="toc-title">On this page</div>
{{ . }}
</div>
{{ end -}}
Expand Down
2 changes: 1 addition & 1 deletion layouts/blog/baseof.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
{{ partial "navbar.html" . }}
</header>
<div class="container-fluid td-outer">
<div class="td-main">
<div class="td-main" {{ partialCached "td/scroll-spy-attr.txt" . | safeHTMLAttr }}>
<div class="row flex-xl-nowrap">
<aside class="col-12 col-md-3 col-xl-2 td-sidebar d-print-none">
{{ partial "sidebar.html" . }}
Expand Down
2 changes: 1 addition & 1 deletion layouts/docs/baseof.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
{{ partial "navbar.html" . }}
</header>
<div class="container-fluid td-outer">
<div class="td-main">
<div class="td-main" {{ partialCached "td/scroll-spy-attr.txt" . | safeHTMLAttr }}>
<div class="row flex-xl-nowrap">
<aside class="col-12 col-md-3 col-xl-2 td-sidebar d-print-none">
{{ partial "sidebar.html" . }}
Expand Down