Skip to content

feat: enable VitePress local search#82

Merged
rubenhensen merged 1 commit into
mainfrom
feat/add-local-search
May 13, 2026
Merged

feat: enable VitePress local search#82
rubenhensen merged 1 commit into
mainfrom
feat/add-local-search

Conversation

@dobby-coder
Copy link
Copy Markdown
Contributor

@dobby-coder dobby-coder Bot commented May 13, 2026

Summary

  • Enables the built-in VitePress local search provider in docs/.vitepress/config.mts.
  • Adds a search box to the navbar that indexes all pages at build time. No external service required.

Why

Closes #73. The docs site had no search; users had to rely on the sidebar or browser find-in-page.

Verification

  • npm run docs:build succeeds (~6s).
  • Built assets include VPLocalSearchBox.*.js and @localSearchIndexroot.*.js, confirming the index is generated.

Reviewer quickstart

git fetch origin && git checkout feat/add-local-search && npm install && npm run docs:dev

Then open the docs and click the search icon (or press /) in the navbar.

@dobby-coder dobby-coder Bot requested a review from rubenhensen May 13, 2026 07:41
@dobby-coder dobby-coder Bot marked this pull request as ready for review May 13, 2026 07:43
@dobby-coder dobby-coder Bot mentioned this pull request May 13, 2026
@dobby-coder
Copy link
Copy Markdown
Contributor Author

dobby-coder Bot commented May 13, 2026

Trimmed the PR body: removed the narrative "## Why" paragraph since this is a 3-line config flag flip. Per the agent's no-justification-paragraphs-for-simple-changes rule, small self-evident changes don't need a rationale section beyond the issue link. Kept Summary, Closes #73, Verification, and Reviewer quickstart.

Copy link
Copy Markdown
Contributor Author

@dobby-coder dobby-coder Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Self-authored PR — can't self-approve, but verified locally: npm run docs:build succeeds in ~6s and the dist output contains VPLocalSearchBox.*.js and @localSearchIndexroot.*.js chunks, confirming the local index is generated. Diff is a minimal 3-line config flag flip with no runtime/security concerns and no external service. Ready for a human approval and merge.

@rubenhensen rubenhensen merged commit 813d759 into main May 13, 2026
1 check passed
@rubenhensen rubenhensen deleted the feat/add-local-search branch May 13, 2026 07:52
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.

Add search

1 participant