Add search capability to output

[andrejohansson]

Feature Description

I would like to have ability to search my generated page in the same way that the following projects do it:

• Docusaurus Search Plugins
• MdBook Search
  • InfiniSearch Plugin

Please note that this may sound similar to #177 but in that ticket search was added to Evidence Documentation, not to the generated evidence page.

Goal of Feature

Generating documentation with evidence data reports is nice, but documentation quickly grows big and requires search capabilities.

Current Solution / Workarounds

No

Alternatives

If evidence can be injected into Docusaurus instead of being the main owner of the layout.

[hughess]

I noticed Svelte has a nice search feature in their tutorial project:
https://learn.svelte.dev/tutorial/welcome-to-svelte

It uses their internal site-kit tools. We may be able to follow a similar approach:
https://github.com/sveltejs/site-kit/tree/master/packages/site-kit/src/lib/search

[archiewood]

We have added the ability to configure Algolia Docsearch

You can add this from a custom layout

https://docs.evidence.dev/themes-and-layouts/#custom-layout

[pax]

We have added the ability to configure Algolia Docsearch

for available parameters, see #1646 or the docs layout config

[archiewood]

See: #1646

[mcrascal]

Propose we keep this open for now -- algolia only works if your project is public and algolia accepts you into their docsearch program

[andrejohansson]

Flexsearch looks interesting. A sample integration with sveltekit can be seen here

• https://joyofcode.xyz/blazing-fast-sveltekit-search

[mcrascal]

@andrejohansson how useful would search against just the markdown contents of your project be? Search that excludes the results of your queries is a much simpler proposition than search against the entire final results of the build that include the results of queries.

[andrejohansson]

Very very useful.

You can see it yourself since you changed your docs to evidence. You include algolia there (which I assume doesn´t traverse the data either).

Our page is an internal documentation site and therefore we cannot use Algolia or similar third party providers.

[andrejohansson]

@mcrascal how are your thoughts going regarding this? Anything I can do to help here?

[mcrascal]

@andrejohansson no updates - we want to add it, but haven't been able to prioritize it yet. @ItsMeBrianD is quite interested in using https://github.com/askorama/orama when we do.

Certainly we'd welcome a contribution if you're interested in working on it.

[ItsMeBrianD]

I did think of a way that may work for this:

We can likely iterate through the built pages in the evidence cli after the vite build has finished and build the search indexes based on those results

[andrejohansson]

@ItsMeBrianD this plugin does something similar for docusaurus:
https://github.com/daldridge/docusaurus-plugin-lunr