🔍 Add client-side search index generation

jupyter-book / mystmd

Command line tools for working with MyST Markdown.

https://mystmd.org/guide

MIT License

219 stars 64 forks source link

🔍 Add client-side search index generation #1530

Closed agoose77 closed 2 months ago

agoose77 commented 2 months ago

This PR tackles #100 by adding support for generation of myst.search.json indices. These can currently be consumed by a webapp on https://agoose77.github.io/myst-search-experiments/?url=http://..., which tries to use myst.search.json, and falls back on using the xref data.

We need jupyter-book/myst-theme#467 to be merged for this to actually be deployed to static builds.

[!WARNING] This PR should merge alongside the other search-related PRs; it is likely that changes in the frontend may warrant modifications to this PR.

changeset-bot[bot] commented 2 months ago

🦋 Changeset detected

Latest commit: e97f56b38479bdc573329f019b45d2b18ecb09df

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 6 packages

| Name | Type | | ---------------- | ----- | | myst-spec-ext | Minor | | myst-cli | Patch | | myst-common | Minor | | myst-config | Minor | | myst-frontmatter | Minor | | mystmd | Patch |

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

agoose77 commented 2 months ago

Making a change to expose a version.

agoose77 commented 2 months ago

Just working on improving the AST to text transform.

rowanc1 commented 2 months ago

We should support 1 apparently. Ideally the CLI should not crash if search index cannot be made!