\n\n\n## Prerequisites\n- Docusaurus V2 or V3\n- Node.js >= 12.X\n\n## How to Use ?\n1. Install this package\n```\nyarn add docusaurus-lunr-search\n```\nor\n```\nnpm i docusaurus-lunr-search --save\n```\nIf npm install fails to install with error `unable to resolve dependency tree`, run `npm i --legacy-peer-deps`\n\n2. Some time npm fails to install `lunr` package, in that case install `lunr` package manually\n```\nnpm i lunr --save\n```\n\n3. Add the docusaurus-lunr-search plugin to your `docusaurus.config.js`\n```\nmodule.exports = {\n // ...\n plugins: [require.resolve('docusaurus-lunr-search')],\n}\n```\n\n4. Then build your Docusaurus project\n```\nyarn build\n```\nor\n```\nnpm run build\n```\n\n5. Serve your application\n```\nyarn serve\n```\nor\n```\nnpm run serve \n```\n\nNote: Docusaurus search information can only be generated from a production build. Local development is currently not supported.\n\n## Using an option (eg. `languages`) in the plugin\n```\nmodule.exports = {\n // ...\n plugins: [[ require.resolve('docusaurus-lunr-search'), {\n languages: ['en', 'de'] // language codes\n }]],\n}\n```\nSupports all the language listed here https://github.com/MihaiValentin/lunr-languages\n\n## Options available\n\n| Option | Type | Default | Description |\n| ------------------- | --------- | -------- | ------------------------------------------------------------------------------------------------------------------------- |\n| `languages` | `Array` | `['en']` | Language codes to use for stemming, Supports all the language listed here https://github.com/MihaiValentin/lunr-languages |\n| `indexBaseUrl` | `Boolean` | `false` | Base url will not indexed by default, if you want to index the base url set this option to `true` |\n| `excludeRoutes` | `Array` | `[]` | Exclude certain routes from the search |\n| `includeRoutes` | `Array` | `[]` | Include only specific routes for search |\n| `stopWords` | `Array` | `[]` | Add stop words(words that are exclude from search result) to the search index |\n| `excludeTags` | `Array` | `[]` | Exclude certain tags from the search \n| `highlightResult` | `Boolean` | `false` | Enable it to highlight the searched word in the result page. Used `mark.js` for highlighting. You can customize the highlight color using css ``` mark { background-color: red !important; color: green !important }``` |\n| `disableVersioning` | `Boolean` | `false` | Docs versions are displayed by default. If you want to hide it, set this plugin option to `true` |\n| `assetUrl` | `string` | `\\` | Url from which the generated search doc files to be loaded, check [issue #122](https://github.com/praveenn77/docusaurus-lunr-search/issues/122) |\n| `maxHits` | `string` | `5` | Maximum number of hits shown |\n| `fields` | `object` | `{}` | Lunr field definitions, allows \"boosting\" priority for different sources of keywords (e.g. title, content, keywords) |\n\n### Options to configure Lunr fields\nThe `fields` config property is passed into Lunr directly as [field attributes](https://lunrjs.com/docs/lunr.Builder.html#field), and can be used to configure the relative priority of different field types (e.g. title, content, keywords). \n\ndocusaurus-lunr-search sets the default value for fields to:\n\n```javascript\n{ \n title: { boost: 200 },\n content: { boost: 2 },\n keywords: { boost: 100 }\n}\n```\n\n## Indexing non-direct children headings of `.markdown`\nBy default, this library will only search for headings that are\n**direct children** of the `.markdown` element. \n\nIf you would like to render content inside the `.markdown` element on\na swizzled DocItem component, and want this library to **index the\nheadings inside those custom elements even if they are not direct\nchildren of the `.markdown` element**, then add the attribute\n`data-search-children` to a parent element of the headings you want to\nindex.\n\nThe `data-search-children` attribute will cause this library to look\nfor all headings inside that element, including both direct and\nindirect children (E.g. 'grandchildren' nodes).\n\nCheck this [issue #115](https://github.com/praveenn77/docusaurus-lunr-search/issues/115) for more details.\n\n## Upgrading from docusaurus V2 to V3\nUpdate the `docusaurus-lunr-search` version to `3.3.0` or higher in `package.json` file\n\nRemove `src/theme/SearchBar` folder if you swizzled it before, if the folder does not exist then ignore this step.\n\nDo `yarn install` or `npm install` \n\nIf npm install fails to install with error `unable to resolve dependency tree`, run `npm i --legacy-peer-deps`\n\n## Credits\n\nThanks to [`algolia/docsearch.js`](https://github.com/algolia/docsearch), I modified it to create this search component \n\nAnd thanks [cmfcmf](https://github.com/cmfcmf), I used the code from his library [docusaurus-search-local](https://github.com/cmfcmf/docusaurus-search-local) for multi-language support.\n\n## Changelog\nCheckout the [releases](https://github.com/lelouch77/docusaurus-lunr-search/releases) page for changelog. \n","readmeFilename":"README.md"}
![\"image\"](\"https://github.com/praveenn77/docusaurus-lunr-search/assets/20218070/dbc54b61-077f-4e11-af27-8798cae8a572.gif\")
\n