Search functionality using local search instead of GCS

[maestrofx]

Goal

To have a local search functionality (indexing words locally) instead of GCS into the internet.

More

First, I found docsy is a great theme for my internal/personal documentation/handbook. In production, I separate the contents (writings) with a static page generator. What functionality I love is indexing and searching capability through a lot of articles I have.

Feature request

• Is there any roadmap to add local search functionality to docsy theme?
• Is this only for Google team's needs btw?

Thank you.

[LisaFC]

Hi, no, it's not just for Google teams - anyone can use it!

We haven't planned adding a local search facility specifically to our theme, but there are various search options available for Hugo sites that you can try with it (some free, some not): https://gohugo.io/tools/search/

[theletterf]

Adding lunrjs or similar is the way to go, but it’s not trivial for non-developers. Anyone willing to help with this? Or at least provide instructions on how to integrate offline search in Docsy.

[theletterf]

@LisaFC I know it’s Google’s, but adding local/offline search can dramatically boost the theme popularity, especially when docs are not meant to be indexed or published in the open. Otherwise, well, guess it’ll be forking time! :-)

[LisaFC]

Oh yeah, I think having non-Google/local search as an option in the theme is great if anyone wants to work on adding it - we chose the Google custom search engine as our default because it was easy and free to add, not because it's from Google.

[roidelapluie]

It would be great if docsy could bring along search (e.g. with https://lunrjs.com/).

Other tools do this (https://squidfunk.github.io/mkdocs-material/getting-started/#site-search) and it is fast and useful for medium websites that are not available over the internet.

[theletterf]

I've offline search with Lunr.js working in my fork. Waiting a bit to polish the code before I open the PR. Could someone try it out and let me know?

[roidelapluie]

request.open("GET", "/index.json", true); => that should repect base url and use relative URL

[roidelapluie]

@theletterf you should put a small doc about how to enable it. I struggle with generating the index.json. And there are issue with relative url's.

I am happy to test this further asap when I know how to generate the index.json ;)

[LisaFC]

I'd love if we had a doc about this!

We will also shortly have (not-offline) Algolia docsearch enabled so there are lots of search options to choose from: #127

[theletterf]

Will try to resume development soon!

[theletterf]

@LisaFC @roidelapluie PR open, at last. :)

#142

[theletterf]

@roidelapluie Not sure how to fix the relative path issue. It's working for me.

[LisaFC]

This is working and checked in thanks to @theletterf :)