Skip to content

v5.1.0

Choose a tag to compare

@ankitskvmdam ankitskvmdam released this 24 Jul 13:08
ed086d8

Highlights

✨ Collapsible sidebar sections — collapsibleSidebarSections

Top-level sidebar section headers (Namespaces, Classes, Interfaces, @category groups, doc groups, Tutorials, …) can now be collapsed. (Closes #343.)

  • true / absent → all sections collapsible (the default)
  • false → none (previous always-static behavior)
  • string[] → only those exact, case-sensitive section labels

Sections default open, and a visitor's collapsed state persists in localStorage. A label that matches no rendered section prints a build warning listing the available labels. Works for both the JSDoc template and the TypeDoc plugin.

⚠️ Visible default change: with no configuration, every top-level sidebar section header now renders as a collapse toggle (still expanded by default, so nothing is hidden on load). Set "collapsibleSidebarSections": false to restore the previous always-static headers.

{
  opts: {
    // all sections collapsible (default) — or false, or an allowlist:
    collapsibleSidebarSections: ["Namespaces", "Classes"]
  }
}

Minor Changes

  • Add collapsibleSidebarSections (see Highlights). (#343)

Patch Changes

  • Footer: the repository link now underlines on hover instead of changing color.

Security

  • No security-relevant changes in this release.

Full changelog: v5.0.8...v5.1.0