Offline search with Lunr.js

[theletterf]

Hi there!

As mentioned in #45, I added offline search with Lunr.js, borrowing heavily from existing tutorials.

How to enable offline search

1. Add offlineSearch = true to the main config.toml file.
2. Add JSON to the outputs for home in the main config.toml file:

[outputs]
	home = [ "HTML", "JSON"]

That's it. Upon build, pages will be indexed into an index.json file by Lunr.js. The whole process is invoked by static/js/offline-search.js, which also handles instant results (thanks @mwalters!).

Styling for the offline search field lives in /static/css/offline-search.css.

Current limitation: I didn't implement a search results page, but it can be done.

[theletterf]

@LisaFC: Not sure why the checks are failing. :-/

[LisaFC]

Ooh, thanks for that. I'll see if I can figure out why the checks are failing.

[LisaFC]

Ok, looks like it was some Netlify weirdosity, I manually reran the deploy and it now works fine! Will take a proper look at the change now.

[LisaFC]

This is great! Once this is in I can add a search-index.md to the example site so it'll actually work if users enable it.

[theletterf]

@LisaFC: all resolved. Only two issues remain:

• My question here on sidebar vs top search behavior: https://github.com/google/docsy/pull/142/files/b6cd4e87e43291f03e723ffff9566831aae5e964#r339473114
• Should we add search-index.md to the docsy repo?

[LisaFC]

@LisaFC: all resolved. Only two issues remain:

Fantastic!

• My question here on sidebar vs top search behavior: https://github.com/google/docsy/pull/142/files/b6cd4e87e43291f03e723ffff9566831aae5e964#r339473114

Answered there, but just to reiterate:

"Aaaaaah, right, I see what's going on. So as you've written it here, it means that the top search field only displays if the sidebar search is disabled (which is what you want for local search and Algolia), but they actually both work fine displayed at the same time if you're using a Google custom search (as you can see on docsy.dev) because it doesn't have an instant results feature.

At the moment for Algolia search we just tell people to disable the sidebar search as it doesn't currently work with Algolia, I think for now we can just do the same for local search. I'll have a think for a future iteration whether we can make the sidebar search automatically disappear if you're using anything except Google custom search."

• Should we add search-index.md to the docsy repo?

We should add it to the user guide and example sites (so for the user guide in this repo, add userguide/content/en/search-index.md)

[theletterf]

@LisaFC Done - and PR opened for search-index.md in the demo site repository: google/docsy-example#33

[LisaFC]

Brilliant, thanks so much for doing this, I think the Docsy community will find this super useful!

[LisaFC]

Ta da! https://www.docsy.dev/docs/adding-content/navigation/#configure-local-search-with-lunr

[theletterf]

Sweet! Thanks!!