ZachJW34 / docusurus-lunr-search

Offline Search for docusurus

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

docusurus-lunr-search

Offline Search for Docusurus V2

How to Use ?

  1. Install this package
npm i docusurus-lunr-search --save
  1. Then run docusurus swizzle
npm run swizzle docusurus-lunr-search SearchBar
  1. Copy the build-search-data.js to the root folder of your project
  2. Then build your Docusurus project
npm run build
  1. Create the search data using by running build-search-data.js
node build-search-data.js
  1. You are done!.
    Now you can build your project again with new search-data.js
npm run build
//or 
npm start

Sample

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

About

Offline Search for docusurus

License:MIT License


Languages

Language:JavaScript 67.3%Language:CSS 32.7%