Docusaurus Lunr Search

screenshot of Docusaurus Lunr Search
docusaurus

Local / Offline Search for docusaurus

Overview:

The docusaurus-lunr-search plugin offers offline search functionality for websites built with Docusaurus V2 or V3. It enables users to search content even when they are not connected to the internet. By following a few simple steps, users can add this plugin to their Docusaurus project and provide a search feature for their audience.

Features:

  • Offline Search: Enables users to search content offline.
  • Support for Multiple Languages: Supports multiple languages for stemming.
  • Customization Options: Various options available such as highlighting search results, excluding certain routes or tags, and setting a maximum number of hits.

Installation:

  1. Install the package by running: npm install docusaurus-lunr-search.
  2. If installation fails with a dependency tree error, run: npm install docusaurus-lunr-search --legacy-peer-deps.
  3. If the lunr package fails to install, install it manually.
  4. Add the docusaurus-lunr-search plugin to your docusaurus.config.js.
  5. Build your Docusaurus project and serve the application.

Summary:

The docusaurus-lunr-search plugin enhances Docusaurus websites by providing offline search functionality. Users can easily install the plugin, customize search settings, and improve the overall user experience by enabling visitors to search content seamlessly. With support for multiple languages and various customization options, this plugin offers a comprehensive solution for search functionality in Docusaurus V2 and V3 websites.

docusaurus
Docusaurus

Docusaurus is an open-source static site generator designed for creating documentation websites. Developed by Facebook, it simplifies the process of building, deploying, and maintaining documentation with its React-based framework and pre-configured setup for documentation projects.

documentation
Documentation

Documentation themes are built specifically for writing technical and product documentation. They are normally written and maintained in Markdown. The often include a navigation menu, search bar, clear headings, semantic document structure and clean typography.