Documentation Guides

Search #

A default, embedded search-engine is provided with the website built. It uses the sources markdown to generate a static index, and elasticlunr for the actual search.

The search can be toggled with Ctrl+K on desktop, or simply clicking the search button on the main nav bar.

Search

The search will return a maximum of 20 results, and can be navigated either using keyboard (Up, Down, Right/Enter) or the mouse. Upon clicking a search-result, you will be directly redirected to the matching page, to the matching section while highlighting the searched keyword.

Search result