anru / docusaurus-lunr-search

Local / Offline Search for docusaurus - Demo at

docusaurus-lunr-search

Offline Search for Docusaurus V2

Demo Website

Sample

How to Use ?

1. Install this package

npm i docusaurus-lunr-search  --save

2. Then run docusaurus swizzle

npm run swizzle docusaurus-lunr-search SearchBar

3. Add the docusaurus-lunr-search plugin to your docusaurus.config.js

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

4. Then build your Docusaurus project

npm run build

5. Serve your application

npx http-server ./build

Note: Docusaurus search information can only be generated from a production build. Local development is currently not supported.

Language options

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

Supports all the language listed here https://github.com/MihaiValentin/lunr-languages

Thanks to algolia/docsearch.js, I modified it to create this search component

And thanks cmfcmf, I used the code from his library docusaurus-search-local for multi-language support.