docs: implement rudimentary full-text search

carbon-design-system / carbon-components-svelte

Svelte implementation of the Carbon Design System

https://svelte.carbondesignsystem.com

Apache License 2.0

2.68k stars 261 forks source link

docs: implement rudimentary full-text search #1849

Closed metonym closed 10 months ago

metonym commented 10 months ago

This PR aims to improve the docs UX by adding client-side, full-text search using minisearch.

The search index is extremely basic; it only searches the component name and example heading. More weight is given to the heading. A maximum of 10 results are shown.

For example: searching "bat" should yield DataTable – batch selection.

Future Work

Example description text should also be indexed.