Skip to content

Release notes

Eugene Lazutkin edited this page Jun 6, 2026 · 5 revisions

Release notes

Detailed release history for wiki-search-index (the npm builder). The README carries the one-line cliff-notes; this page carries the detail.

0.1.1 (2026-06-06)

HTML entity decoding in text extraction. The builder now resolves HTML entities (—, →, Ӓ, 🔍, …) while reducing Markdown to searchable text. Previously they passed through verbatim and the tokenizer split them into junk terms (—mdash, 🔍128269); snippets also showed the literal entity. Now: numeric entities decode generally, so a genuinely letter-valued entity like α (α) is preserved as a real term while typographic/symbol entities (em dash, arrows, emoji) decode to characters the tokenizer discards — and snippets render the glyph. Indices for wikis written in literal Unicode (the common case) are byte-identical; only entity-using wikis change. Output stays deterministic, so the committed-index git diff --exit-code staleness gate still holds.

Related (the hosted app, not the npm package): the bookmarklet's ?from= detection now resolves owner/repo from any github.com/<owner>/<repo> page — the repo root, /actions, /pull/N, etc. — not just /wiki/… pages, so the bookmarklet works from anywhere in a repo.

0.1.0

Initial release of the wiki-search-index CLI — compiles a GitHub wiki (or any Markdown docs) into a self-describing v1 search index (see Index Format):

  • npx wiki-search-index --wiki ./wiki<wiki>/search-index.json.
  • GitHub-slugger-accurate anchors; deterministic output (sorted, no timestamps) so a CI git diff --exit-code can gate index staleness.
  • Owner/repo inferred from the wiki dir's git origin; --repo / --url-template for explicit or non-GitHub sites.

Ships alongside the hosted search app + the install-from-origin bookmarklet on GitHub Pages.

Clone this wiki locally