{"repo":"praveenn77/docusaurus-lunr-search","free":true,"listed":false,"github":"https://github.com/praveenn77/docusaurus-lunr-search","clone":"git clone https://github.com/praveenn77/docusaurus-lunr-search.git","description":"Local / Offline Search for docusaurus","language":"JavaScript","stars":559,"topics":["lunr","documentation","docusaurus","offline-search","docusaurus2"],"license":"MIT","category":"docs-static-sites","readme_excerpt":"docusaurus-lunr-search Offline Search for Docusaurus v3.9.2+ Demo Website Screenshot Prerequisites - Docusaurus v3.9.2 - Node.js = 20.X How to Use? 1. Install this package or If npm install fails to install with error unable to resolve dependency tree , run npm i --legacy-peer-deps 2. Sometimes npm fails to install lunr package, in that case install lunr package manually 3. Add the docusaurus-lunr-search plugin to your docusaurus.config.js 4. Then build your Docusaurus project or 5. Serve your application or Note: The Docusaurus search index is only generated from a full project build. The local development server does not provide search functionality. Using an option (eg. languages ) in the plugin Supports all the language listed here https://github.com/MihaiValentin/lunr-languages Options available Option Type Default Description ------------------- --------- -------- ------------------------------------------------------------------------------------------------------------------------- languages Array ['en'] Language codes to use for stemming, Supports all the language listed here https://github.com/MihaiValentin/lunr-languages indexBaseUrl Boolean false Base url will not indexed by default, if you want to index the base url set this option to true excludeRoutes Array [] Exclude certain routes from the search includeRoutes Array [] Include only specific routes for search stopWords Array [] Add stop words(words that are exclude from search result) to the search index exclu","default_branch":null,"files":null,"tree":[],"storefront":"/r/praveenn77","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/praveenn77/docusaurus-lunr-search/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}