Script loading

Mon, 01 Jan 0001 00:00:00 +0000

_partials/scripts/plugins.html implements params.docsy.plugins. For the configuration reference and the plugin file contract, see the plugins guide; for the design rationale, the design notes; for the tests that pin this contract, the quality notes.

Loop mechanics

The template’s comments carry the mechanics and their rationale. The loop reads the theme’s schema through hugo.Data; the guide renders the same file, so the entry contract has one home.

Shims

For when to add or replace a shim, see the guide’s Adjust a plugin per page; this section is the contract.

ScrollSpy patch

Mon, 01 Jan 0001 00:00:00 +0000

As of Docsy 0.13.0

Summary

Docsy 0.13.0 includes a runtime patch for Bootstrap ScrollSpy that fixes a bug affecting pages with heading IDs that aren’t valid CSS selectors. The patch ensures that active TOC entry tracking works reliably for all pages.

Problem

As of Bootstrap 5.3.8 (the version used by Docsy 0.13.0), ScrollSpy fails if a page contains a heading ID that is not also a valid CSS # selector. This can happen, for example, if a heading ID starts with a digit. For technical details about this bug, see #2329.

Implementation on Docsy

Script loading

Loop mechanics

Shims

ScrollSpy patch

Problem