Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs: add search support #1433

@LayZeeDK

Description

@LayZeeDK

Problem Solved By The Feature

When migrating to a Docusaurus website, we lost out-of-the-box search functionality. This increases the burden of finding a specific piece of information on the website and online documentation.

Solution

Option A: Algolia DocSearch

The @docusaurus/preset-classic preset has native support for Algolia DocSearch and open-source projects can apply for a free Algolia DocSearch license.

Option B: Local search

Suggestion: Docusaurus Search is a local/offline search plugin for Docusaurus, meaning no 3rd party service is required. See alternatives in alternatives Considered.

alternatives Considered

Client-side search

docusaurus-plugin-lunr - Docusaurus v2 plugin to create a local search index for use with Lunr.js
docusaurus-lunr-search - Offline Search for Docusaurus v2
docusaurus-search-local - Offline/local search for Docusaurus v2
docusaurus-theme-search-typesense - Docusaurus v2 plugin for Typesense DocSearch.

Additional Context

Metadata

Metadata

Assignees

Labels

📚 Docs WebDocumentation hosted on github pages

Type

No type

Projects

Status

Done

Relationships

None yet

Development

No branches or pull requests

Issue actions