Offline Search Option

[sheldonhull]

Is this a bug report?

no

Offline search functionality

Has anyone successfully implemented Lunr.js or another offline based search provider? I'm looking to create a offline static documentation site, and can't grant a web crawler the ability to index. I need to leverage something offline like Lunr, solr, or another option, but haven't done that before. Is this a possible enhancement, or anyone successfully done this and willing to share how to do it?

[JoelMarcey]

Hi @sheldonhull. I have not added an offline search provider. But I imagine you could follow https://lunrjs.com/guides/getting_started.html and do some stuff in siteConfig.js to add it. And then maybe mimic how we add Algolia to the header links bar for Lunr?

[sheldonhull]

Thanks! I ended up sticking with Mkdocs as I had an easier time using what was already built in. Just was a better fit for what I already knew how to use. You guys have a great project though, thanks for the hard work!

[wulucxy]

@sheldonhull do you have solved this problem? my website is only for company-internal network，so the recommend Algolia DocSearch is not suitable for me。

[njsokol]

This would be an awesome feature

[bram209]

I would love this feature as well

[danerich]

This would be a great addition!

[ghost]

+1

[KerimG]

+1

Doubt we'll ever see this feature, though.

[JoelMarcey]

@KerimG I wouldn't say never. It is on on our v2 roadmap.

[prakhar-goel]

+1 for offline search using lunrjs or similar. We are using Docusaurus for internal company documentation and therefore cannot use default Algolia search. Ability to search through markdown files would be a great add on to the current version.

[ishanmihir19]

+1

[ghost]

I have implemented, search with Elastic lunar and node js for one of our internal sites. I will share the code tonight. That may be helping.

[JoelMarcey]

Just as an FYI - @sbansal3096 is working on this as part of #776.

This is actually a duplicate issue.

Please follow #776 for updates.

[joetidee]

Algolia search system is a deal-breaker for us.

[lelouch77]

I created an offline search plugin that looks similar to algolia search using lunr.js Check it out ..
https://github.com/lelouch77/docusaurus-lunr-search

Live Demo is available at https://lelouch77.github.io/docusaurus-lunr-search-demo/

[kamdjouduplex]

@lelouch77 thank you very much for this plugin, I succeed integrating it on my docusaurus v2 project in a minute.
good job!

[joan38]

Not working for me, I get a:

Error: Cannot find module 'docusaurus-lunr-search'

[GustavoAngulo]

@joan38 Did you find a fix for the Cannot find module error? CC: @lelouch77

[lelouch77]

@joan38 @GustavoAngulo Seems there some issues including node module in plugin with new version of docusaurus, just change your docusaurus.config.js as follow.

const path = require('path');
module.exports = {
  // ...
    plugins: [path.resolve(__dirname, './node_modules/docusaurus-lunr-search/')],
}