doks
doks copied to clipboard
gethyas
Add Algolia Search (next to FlexSearch) as an option
Summary
Basic example
Motivation
- https://github.com/h-enk/doks/discussions/120
I am confused, why does getdoks.org already use algolia while this repo does not use it?
@NicoHood see https://github.com/h-enk/doks/discussions/120 where we discuss this - I think the original motivation was to have a free search method but thoughts regarding search have changed recently.
It looks like you're switching how search is provided in Doks, but I wanted to inquire about the current state. By default, it doesn't seem like flexsearch works in a freshly cloned repo. I've tried changing the variables (using "ALL", etc., in the config), but the indexing variable seems to have no effect on behavior (though the show one works). Is there a command or similar I'm missing that builds the index? Should I just roll my own here for now?
Thanks, enjoying Doks.
No, I'm not switching. FlexSearch is the best search solution for static websites — in my opinion.
Not sure, why it doesn't work for you. Do you have a repository you could share?
Note, Doks v1.0 (available soon) will have more advanced options ( e..g select sections, taxonomies, and terms to index) and uses a smarter setup (e..g. using a JSON index file).
The repo is here:
https://github.com/smythp/sigstore-docs-replatform
I've reenabled the search. The flex-related variables are set to empty lists, though I've gone through a number of permutations. Thank you for any guidance, I was going to set up another provider but I'd prefer to try to get the default for this theme working.
It's an issue in the file that generates the index (it fails on a commented-out part).
Delete these lines and you're good to go!
https://github.com/smythp/sigstore-docs-replatform/blob/main/assets/js/index.js#L78-L94
Doks comes with FlexSearch preconfigured out of the box. If you want to use DocSearch in stead, this guide will explain how.