Skip to content

Home

Jump to bottom
Eugene Lazutkin edited this page Jun 5, 2026 · 7 revisions

wiki-search

A reusable, self-describing search kit for any wiki or docs site. Generate a versioned JSON index from your docs, host it anywhere CORS-readable, and point a hosted search app and/or a bookmarklet at it. Clients assume nothing beyond a self-describing JSON contract; every failure explains itself.

It exists because open GitHub wikis are excellent for docs but have no good search — and their Content-Security-Policy blocks on-page search engines. wiki-search bolts search beside the wiki instead of migrating docs away from it.

Start here

  • Overview — the idea, the problem it solves, the guiding principle.
  • Architecture — how it works (the "Flip-It" 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.

Try it

git clone --recursive https://github.com/uhop/wiki-search.git
cd wiki-search
node builder/wiki-index.mjs --wiki ./wiki --stdout   # build this wiki's index
python3 -m http.server 8080                           # then open /app/

The project is early — the architecture is settled and the builder works; the app and bookmarklet are being built out phase by phase (see Roadmap).

wiki-search

Repository · INDEX-FORMAT

Clone this wiki locally