Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Algolia Search (next to FlexSearch) as an option #130

Closed
h-enk opened this issue Feb 9, 2021 · 8 comments
Closed

Add Algolia Search (next to FlexSearch) as an option #130

h-enk opened this issue Feb 9, 2021 · 8 comments
Assignees
Labels
dependencies This issue or pull request updates a dependency enhancement New feature or request

Comments

@h-enk
Copy link
Member

h-enk commented Feb 9, 2021

Summary

Basic example

Motivation

@h-enk h-enk added enhancement New feature or request dependencies This issue or pull request updates a dependency labels Feb 9, 2021
@h-enk h-enk self-assigned this Feb 9, 2021
@NicoHood
Copy link

I am confused, why does getdoks.org already use algolia while this repo does not use it?

@teamcrisis
Copy link

@NicoHood see #120 where we discuss this - I think the original motivation was to have a free search method but thoughts regarding search have changed recently.

@h-enk h-enk added this to the v0.3.0 milestone Feb 22, 2021
@h-enk h-enk pinned this issue Mar 5, 2021
@h-enk h-enk unpinned this issue Mar 17, 2021
@h-enk h-enk changed the title Replace FlexSearch with Algolia Search Add Algolia Search (next to FlexSearch) as an option Apr 6, 2021
@h-enk h-enk modified the milestones: v0.3.0, v0.3.1 Jun 25, 2021
@h-enk h-enk modified the milestones: v0.3.4, v0.3.5 Sep 7, 2021
@h-enk h-enk modified the milestones: v0.3.5, v0.4.0 Sep 21, 2021
@h-enk h-enk added the keep label Jan 14, 2022
@h-enk h-enk modified the milestones: v0.4.0, v0.5.0 Jan 17, 2022
@h-enk h-enk modified the milestones: v0.5.0, v0.6.0 Jun 21, 2022
@h-enk h-enk removed this from the v0.6.0 milestone Apr 18, 2023
@smythp
Copy link

smythp commented Aug 3, 2023

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.

@h-enk
Copy link
Member Author

h-enk commented Aug 14, 2023

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).

@smythp
Copy link

smythp commented Aug 14, 2023

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.

@h-enk
Copy link
Member Author

h-enk commented Aug 14, 2023

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

@smythp
Copy link

smythp commented Aug 14, 2023

Henk, this worked like a charm. Thank you.

@h-enk h-enk removed the keep label Jan 8, 2024
@h-enk
Copy link
Member Author

h-enk commented Jan 8, 2024

Doks comes with FlexSearch preconfigured out of the box. If you want to use DocSearch in stead, this guide will explain how.

@h-enk h-enk closed this as completed Jan 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies This issue or pull request updates a dependency enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants