Skip to content
Closed
Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
168 commits
Select commit Hold shift + click to select a range
b7fd7ac
Make it possible to use a javascript-based page-level toc
fekete-robert Oct 18, 2022
d350531
Documents the new sidebar
fekete-robert Oct 18, 2022
523c85f
Merge branch 'main' into right-hand-tocbot
fekete-robert Jun 3, 2023
dc8ec1a
Merge branch 'main' into right-hand-tocbot
fekete-robert Jun 21, 2023
8355cc0
Fix script URL for non-top-level baseurls
fekete-robert Jul 4, 2023
dd2cff3
Typo fix
fekete-robert Jul 4, 2023
32d7e4a
Update layouts/partials/scripts.html
fekete-robert Jul 4, 2023
b9a08fa
Update tocbot.min.js to 4.21.0
fekete-robert Jul 10, 2023
9bfa781
Adds release link and license to tocbot files, updates tocbot to 4.21.0
fekete-robert Jul 10, 2023
ceb6327
Merge branch 'main' into right-hand-tocbot
fekete-robert Jul 10, 2023
2bf0108
Update assets/scss/tocbot.css
fekete-robert Feb 13, 2024
2c51bfd
Merge branch 'main' into right-hand-tocbot
fekete-robert Apr 26, 2024
1033c6c
Drop RSS layout in favor of Hugo's default (#1948)
chalin Apr 26, 2024
b0fd7be
section-index.html code cleanup (#1947)
chalin Apr 26, 2024
387aafd
Upgrade to Hugo 0.125.4 (#1950)
chalin Apr 26, 2024
f193e4f
Docsy 0.10.0 release report (#1945)
chalin Apr 29, 2024
cb1f948
[Dark mode] Left-nav and taxonomy color fixes (#1952)
chalin Apr 29, 2024
475551a
Use official hugo-extended NPM package + UG tweak (#1956)
chalin Apr 29, 2024
c03c1df
Bump Persian fonts to latest version (#1955)
deining Apr 30, 2024
3d638e9
copyright.html: process `.Site.Copyright` as HTML (#1954)
chalin Apr 30, 2024
07d01b3
[UG] Syntax highlighting styles for both light and dark modes (#1958)
chalin Apr 30, 2024
4b589ed
[Dark mode] Factor out code-dark styles for reuse (#1959)
chalin Apr 30, 2024
5bc4519
Mark 0.10.0 release report as draft (#1960)
chalin Apr 30, 2024
bc37ac9
Format mermaid.html (#1963)
chalin Apr 30, 2024
f110c86
Set Mermaid theme based on light/dark mode (#1964)
chalin Apr 30, 2024
7ede6fe
Mermaid: stick to default when not dark mode (#1965)
chalin Apr 30, 2024
dee34b4
Dark-mode override for `.td-box--white` (#1966)
chalin Apr 30, 2024
b45af6c
Restrict `.td-box--white` style changes to dark mode (#1968)
chalin Apr 30, 2024
3a12f00
Format lookandfeel.md - no content changes (#1969)
chalin Apr 30, 2024
a417b33
[Dark mode] Fix blocks/lead down arrow color (#1971)
chalin Apr 30, 2024
468b0e8
Rename chroma styles (#1974)
chalin May 1, 2024
bf7ce0f
[CI] Add scripts to generate and check Chroma styles (#1976)
chalin May 1, 2024
5e1c215
[CI] Setup fix:format for the UG (#1977)
chalin May 1, 2024
a819858
[UG] Document light/dark mode config (#1978)
chalin May 1, 2024
6aab0d0
Contribution guidelines: document use of Prettier (#1980)
chalin May 1, 2024
cddcac1
[Dark mode] blockquote and click-to-copy color fixes (#1981)
chalin May 1, 2024
4be813d
[CI] use userguide/.prettierignore to specify files to ignore (#1982)
chalin May 1, 2024
f60d281
Fix warning about LaTeX-incompatible input (#1984)
deining May 1, 2024
8d9f489
Release 0.10.0 prep (#1983)
chalin May 1, 2024
9687e6e
Set package version to 0.10.1-dev (#1986)
chalin May 7, 2024
79e7ac1
Upgrade to Hugo 0.125.7 (#1993)
chalin May 9, 2024
a7d1b6c
UG site config cleanup re lang params (#1994)
chalin May 9, 2024
5aaf5af
Update Hugo to 0.126.1, script name tweaks, and more (#2000)
chalin May 16, 2024
f8c4c16
[CI] UG NPM script tweaks (#2007)
chalin May 16, 2024
dd82c75
Cleanup of Google analytics templates (#2006)
chalin May 16, 2024
16852f3
Add RTL support using BSv5 (#2002)
chalin May 16, 2024
fa7541e
[RTL] Drop unused style files (#2020)
chalin May 28, 2024
6c084c0
[RTL] Fix top-nav position (#2018)
chalin May 28, 2024
3f67a44
[RTL] Add CHANGELOG entry and drop RTL for `en` (#2021)
chalin May 28, 2024
5663817
Fixed code-dark path (#2022)
jqueraltmo May 28, 2024
56d22f7
[RTL] Warn if RTL CSS not found + Hugo mod fix + more (#2027)
chalin May 29, 2024
eca1486
User guide, deployment page: add section 'Deployment on GitHub Pages'…
deining May 31, 2024
68ee81d
Update all NPM packages to latest, add `update:pkgs` script, and more…
chalin Jun 4, 2024
544397f
Add note on SwaggerUI and networking (#2030)
theletterf Jun 4, 2024
af5d92d
Add YMCA Website Services to Example Sites (#2037)
froboy Jul 1, 2024
ebcdb5d
[UG][cleanup] Updating Docsy: run Prettier and cleanup front matter (…
chalin Aug 5, 2024
49faeba
Upgrade Hugo, Prettier, and Font-Awesome (#2059)
deining Aug 5, 2024
26b4380
[infra] Upgrade all NPM packages, including Hugo to 0.131.0 (#2063)
chalin Aug 5, 2024
1df521f
[CI] Don't check links under Windows (#2064)
chalin Aug 5, 2024
149805c
[CI][UG] Serve to memory and disable fast render (#2066)
chalin Aug 5, 2024
81dfdeb
[feat] Support `contributingUrl` param (#2067)
chalin Aug 6, 2024
3e9bd6a
[UG] Add missing markdown link definition (#2068)
chalin Aug 7, 2024
99a1a7c
Add config option to control child page limit (#1334)
viren-nadkarni Aug 7, 2024
9de762e
Documents the body_class parameter (#1541)
fekete-robert Aug 7, 2024
a9e1592
Adds a warning when truncating sidebar section entries (#2069)
chalin Aug 8, 2024
75bcecd
Update uk.toml (#2071)
Andygol Oct 1, 2024
402293a
Replaced some instances of older config.yaml and config.json in userg…
SayakMukhopadhyay Oct 1, 2024
9cd0383
Update ar.toml -Enhance Arabic User Experience with Feedback Labels a…
jadmadi Oct 1, 2024
37c8634
Add support for Serbian language (cyrillic & latin) (#2088)
rammba Oct 1, 2024
88a0c73
remove rss_sections from docs (#2087)
LDReid Oct 1, 2024
9571ebe
Update Hugo to 0.133.1, and other pkgs (#2092)
chalin Oct 10, 2024
c332d64
RTL support via a single main style file (#2093)
chalin Oct 10, 2024
46a79b3
[RTL] Drop unused BS asset and scripts to fetch it (#2097)
chalin Oct 15, 2024
4332562
[UG] Add RTL config section (#2098)
chalin Oct 15, 2024
a9fd843
[fa] i18n: add remaining entries (#2099)
chalin Oct 17, 2024
6b43186
Header meta description: use same strategy as Hugo (#2100)
chalin Oct 17, 2024
f5a8d1a
Release 0.11.0 preparation (#2101)
chalin Oct 18, 2024
09892ef
Update packages: Hugo to 0.136.5 (#2106)
chalin Oct 30, 2024
d433b4e
Add missing feedback section in french (#2105)
codeboten Oct 31, 2024
12bfbf6
Set NPM package version to next unreleased dev version (#2109)
chalin Nov 6, 2024
daff199
Update pkgs, with Hugo to 0.137.0 (#2112)
chalin Nov 6, 2024
0603bc8
[UG] NPM install: add `npm init` and switch to YAML config (#2114)
chalin Nov 6, 2024
d05df5f
Delete .s3deploy.yml (#2111)
chalin Nov 6, 2024
aa96f2f
[CI] Make build checks pass again, skip .md link checking (#2118)
chalin Nov 6, 2024
dfafa63
User guide: correct instructions on how to disable RSS feed (#2104)
deining Nov 6, 2024
35622fd
[UG] Give guidance on what to do on "failed to load modules" error (#…
chalin Nov 6, 2024
6190da4
External link checking + project pages (#2120)
chalin Nov 15, 2024
1a3dca0
[CI] Restore format check as a part of `npm test` (#2124)
chalin Nov 15, 2024
b759f39
Upgrade Hugo and merge optional deps into dev (#2125)
chalin Nov 15, 2024
26308c2
Fix typo in deployment documentation (#2123)
shihyuho Nov 16, 2024
d03e7db
Update CHANGELOG.md: fix copy-paste error (#2127)
chalin Nov 19, 2024
a531819
[CI] Handle creation of empty Hugo-modules for deps (#2128)
chalin Nov 19, 2024
29702e3
Upgrade Hugo and FontAwesome (#2129)
chalin Nov 20, 2024
995fd9c
[CI] Patch search page HTML until Hugo is fixed, FA upgrade (#2135)
chalin Nov 23, 2024
d01c3be
[CI] Upgrade NPM pkgs, Hugo to 0.139.4 (#2143)
chalin Dec 12, 2024
8be30ef
Blog 2024 year in review (#2145)
chalin Dec 12, 2024
bbbbb29
Blog 2024 review: Add link to LFX mentorships (#2147)
chalin Dec 12, 2024
b8a9c88
Bump dependency Font-Awesome to latest version 6.7.2 (#2151)
deining Jan 3, 2025
0d45930
i18n: Add feedback_* to i18n/ja.toml (#2149)
rinsuki Jan 4, 2025
7fe5d7a
[CI] Upgrade NPM pkgs, Hugo to 0.140.2 (#2154)
chalin Jan 7, 2025
8683d42
Blog list layout refactoring (#2155)
chalin Jan 7, 2025
cba6e48
Blog list layout: display the page title and content (#2157)
chalin Jan 8, 2025
9243e15
Blog list layout whitespace cleanup (#2159)
chalin Jan 8, 2025
5ff062a
Hide index-page single breadcrumb (#2160)
chalin Jan 8, 2025
90558a5
Render-heading: process class attributes (#2165)
chalin Jan 9, 2025
4b5e598
Userguide config cleanup, drop pygments config (#2166)
chalin Jan 9, 2025
5a5f6ba
Update and improve zh-TW Traditional Chinese locale (#2158)
PeterDaveHello Jan 9, 2025
991045f
Bump KaTeX to latest version (#2168)
deining Jan 9, 2025
fcde2b6
Breadcrumb for blog pages, and per-page/section config (#2161)
chalin Jan 10, 2025
d2e3bce
Fix error when building user guide with latest hugo version 0.141.0 (…
deining Jan 20, 2025
031761b
[CI] Upgrade NPM packages (#2179)
chalin Jan 20, 2025
445cf2d
Drop style attribute using undef CSS var (#2180)
chalin Jan 21, 2025
c173057
Remove docsy's custom shortcode 'figure' (#2175)
deining Jan 21, 2025
ffcef65
Update Hugo to 0.142.0, and more (#2182)
chalin Jan 24, 2025
e525bab
Fix language-drop style when in left nav (#2183)
chalin Jan 30, 2025
86696e7
Upgrade Hugo to 0.143.0 and add comment shortcode (#2188)
chalin Feb 4, 2025
a159a25
User guide, LaTeX: typesetting of formulae using standard syntax (#1858)
deining Feb 6, 2025
13a35cb
Revert "UG LaTeX: typesetting of formulae using standard syntax (#185…
chalin Feb 10, 2025
68d4aea
Upgrade Hugo to 0.143.1, etc (#2191)
chalin Feb 10, 2025
9ab72aa
[feat] Add base support of td-content-after-header hook (#2192)
chalin Feb 10, 2025
98bdeeb
Add link def to CHANGELOG and clean up whitespace (#2193)
chalin Feb 10, 2025
e5958c6
[UG] Explain how to implement custom search (#2202)
chalin Mar 18, 2025
e903d55
[UG] Run Prettier over search.md page (#2203)
chalin Mar 19, 2025
03f79b5
Update NPM pkgs, Hugo to 0.145.0 (#2204)
chalin Mar 19, 2025
ba38a50
Heading render hook: support all attributes (#2206)
chalin Mar 21, 2025
3cda8fd
Replace 404'd link to cross reference docs with API reference for rel…
nathan-contino Apr 15, 2025
6590882
user guide: fix preview with latest hugo version 0.146.5 (#2215)
deining Apr 23, 2025
de19ecb
Fix typo (#2219)
deining Apr 23, 2025
43aafc6
Bump dependency bootstrap to latest released version 5.3.5 (#2222)
deining Apr 23, 2025
8650551
Rename Docsy's render-heading hook and helper partial (#2223)
chalin Apr 24, 2025
e2c45ac
User guide: remove deprecated kind 'taxonomyterm' from disableKinds (…
deining Apr 26, 2025
fce1e2c
Update pkgs: Hugo to 0.147.0, etc (#2228)
chalin Apr 26, 2025
2bc0e7a
[UG] Taxonomy page copyedited & prettified (#2229)
chalin Apr 28, 2025
941ef5b
Enable blank issue template (#2231)
chalin May 2, 2025
b5e79c9
Update Hugo to 0.147.2, and netlify-cli (#2239)
chalin May 14, 2025
0db7b26
Update Bootstrap to 5.3.6 (#2240)
chalin May 14, 2025
d3723f0
Cleanup: drop temporary GA template (#2237)
deining May 14, 2025
e7cf72a
Update packages, Hugo to 0.147.3 (#2242)
chalin May 16, 2025
b245acb
[UG] Run Prettier over all pages under `adding-content` (#2244)
chalin May 16, 2025
9ac2109
Move layouts/_default/_markup one level up, adjusts UG (#2246)
chalin May 16, 2025
a3d5db6
Add underscore to `partials` and `shortcodes` directory names (#2247)
chalin May 16, 2025
706042a
Check all external links, fix broken links (#2249)
chalin May 16, 2025
d74811a
User guide: fix wrong file name, update version information (#2251)
deining May 16, 2025
758020b
Drop `_internal` prefix from template paths (#2250)
chalin May 22, 2025
b1976fa
Update NPM pkgs, Hugo to 0.147.4 (#2254)
chalin May 22, 2025
ef06182
Moving some files out of `layouts/_default`, and using `all.html` (#2…
chalin May 22, 2025
04b10d4
Move new content-after-header hook into partials folder, add UG entry…
chalin May 22, 2025
8dd0edd
Move taxonomy and terms out of _default (#2257)
chalin May 22, 2025
3fec88b
User guide: minor improvements (#2258)
deining May 22, 2025
e2dda3c
Rename layout fragment to include `_td` prefix (#2259)
chalin May 22, 2025
531f0d7
Changelog updates for layout refactorings (#2260)
chalin May 23, 2025
1a27d47
Make content-after-header a layout fragment again (#2261)
chalin May 23, 2025
e9ea1c0
Config file misc clean up and refcache update (#2262)
chalin May 23, 2025
0223587
Update Hugo to 0.147.5 (#2263)
chalin May 27, 2025
c1de605
Linting of .scss files (#2253)
deining May 27, 2025
7f7fa9e
Update Ukrainian translation file (uk.toml): fixed errors, added miss…
JackArton May 27, 2025
d6fa4c2
Update Swagger UI to 5.21.0 (latest) (#2252)
Gr3q May 27, 2025
5550f49
i18n PT-BR: Added missing key, updated translations (#2233)
luigicaetano May 27, 2025
30cc3f0
Use font-weight-bold variable (#2234)
jorado May 27, 2025
59da02c
Streamline README.md and other copyedits (#2264)
chalin May 27, 2025
594db0f
i18n Norwegian: Added missing key, updated translations (#2186)
chrish May 27, 2025
2a32624
User guide, LaTeX: typesetting of formulae using standard syntax (II)…
deining May 27, 2025
f6d0d07
Update min Hugo version in theme config, and some UG copyedits (#2267)
chalin May 27, 2025
02a2412
Release v0.12.0 preparation (#2265)
chalin May 27, 2025
156a786
Set NPM package version to next unreleased dev version 0.12.1-dev (#2…
chalin May 27, 2025
dc50394
i18n: adds Occitan locale (#2173)
ensag-dev May 27, 2025
3a7cc94
Make it possible to use a javascript-based page-level toc
fekete-robert Oct 18, 2022
c7c6253
Make it possible to use a javascript-based page-level toc
fekete-robert May 30, 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
1 change: 1 addition & 0 deletions assets/scss/main.scss
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
@import "taxonomy";
@import "drawio";
@import "shortcodes";
@import "tocbot";

@if $td-enable-google-fonts {
@import url($web-font-path);
Expand Down
1 change: 1 addition & 0 deletions assets/scss/tocbot.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

18 changes: 18 additions & 0 deletions layouts/partials/scripts.html
Original file line number Diff line number Diff line change
Expand Up @@ -80,4 +80,22 @@
{{ end -}}

<script src='{{ "js/tabpane-persist.js" | relURL }}'></script>

{{ if .Site.Params.jstoc.enable }}
<!-- Initialize tocbot -->
<script src="/js/tocbot.min.js"></script>
<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>
{{ end }}

{{ partial "hooks/body-end.html" . -}}
1 change: 1 addition & 0 deletions static/js/tocbot.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

25 changes: 25 additions & 0 deletions userguide/content/en/docs/adding-content/lookandfeel.md
Original file line number Diff line number Diff line change
Expand Up @@ -287,3 +287,28 @@ Both `head.html` and `scripts.html` are then used to build Docsy's [base page la
</html>
```

## 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)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.