Home
GitHub wikis are great for docs but have no real search. wiki-search adds it — a bookmarklet (plus a hosted search page) that searches a wiki and takes you straight to the matching section, without moving your docs off the wiki.
🔍 Search this wiki · install the bookmarklet to search any wiki in place · or use GitHub's own search box.
See Add Search — build an index from your Markdown with
npx wiki-search-index, commit it, and drop in a one-line Search section. You can
even fold your README's API docs into the same index (--file README.md). Keeping
it fresh (manual, agent, or a GitHub Action) is covered there too.
- Overview — the idea, the problem it solves, the guiding principle.
- Architecture — how it works (the popup, the index, positioning).
- Design Decisions — what we chose, what we rejected, and the research behind it.
- Index Format — the versioned, self-describing JSON contract.
- Roadmap — the plan and current status.
- Release notes — version history (cliff-notes live in the README).