Skip to content

Guide section anchors, sidebar outline, and a Finding Spoons section - #398

Open
cmsj wants to merge 2 commits into
mainfrom
docs/guide-outline
Open

cmsj wants to merge 2 commits into
mainfrom
docs/guide-outline

Conversation

@cmsj

@cmsj cmsj commented Nov 17, 2026

Copy link
Copy Markdown
Owner

Summary

  • Section anchors: guide headings (h2–h4) get a # self-link on hover, so any section can be linked to directly.
  • Sidebar outline: the active guide's entry in the left sidebar expands into an outline of its h2/h3 sections. As you scroll, the current section is highlighted and only its sub-sections are expanded, so long guides like hs.canvas don't flood the sidebar.
  • Finding Spoons: a new section at the start of the Spoons guide pointing at the hammerspoon2-spoon GitHub topic and r/Hammerspoon. "Sharing a Spoon" now suggests authors use both.

The guide nav list in base.njk is now built from a list instead of five hard-coded links, so the outline can be rendered under whichever guide is active.

Testing

  • npm run docs:generate and npm run docs:test pass.
  • Rendered the hs.canvas guide in headless Chrome and the outline renders under its entry. Scrolling to "Gradients" (checked via the DOM) highlights that link and expands its parent "The element pipeline".

🤖 Generated with Claude Code

cmsj and others added 2 commits November 17, 2026 21:12
Guide headings get a hover "#" self-link, and the active guide's entry
in the left sidebar expands into an outline of its h2/h3 sections. The
section being read is highlighted as you scroll, and only its
sub-sections are expanded, so long guides don't flood the sidebar.

Changelog-Added: Documentation guides now have linkable section headings, and the sidebar shows an outline of the guide you're reading
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Points readers at the hammerspoon2-spoon GitHub topic and r/Hammerspoon,
and suggests Spoon authors use both to make their Spoons discoverable.

Changelog-Added: A "Finding Spoons" section in the Spoons guide
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@greptile-apps

greptile-apps Bot commented Nov 17, 2026 •

Copy link
Copy Markdown
Contributor

RetriggerView in GreptileConfidence Score: 5/5

[Low impact] The PR appears safe to merge.

Summary

Adds section self-links and an outline beneath the active guide in the sidebar.

  • Guide headings link directly to sections, and the sidebar follows the reader's place.
  • The Spoons guide points readers to places to find and share bundles.

Reviews (1) · Last reviewed commit: "Add a Finding Spoons section to the Spoo..." · Reviewed by Greptile

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant