An app that adds search capabilities to generated documentation for purescript code.

It supports nearly-all functionality of Pursuit, including querying by type.

Run npm install purescript-docs-search.

When using spago, you don't need to install this app. Just run spago docs or spago search.

There are two usage scenarios:

Use purescript-docs-search build-index command to patch HTML files located in generated-docs/html. You then will be able to search for declarations or types:

The user interface of the app is optimised for keyboard-only use.

S hotkey can be used to focus on the search field, Escape can be used to leave it. Pressing Escape twice will close the search results listing.

Running purescript-docs-search within a project directory will open an interactive command-line session.

Note that unlike in Pursuit, most relevant results will appear last.

A quick demo:

You may notice that the CLI offers slightly better results than the web interface. This is a performance tradeoff.