Skip to content

Feature Request: Searchable Docs (possibly with a docsaurus 2 plugin) #609

Open
@markmelville

Description

@markmelville

I have often wished for a search feature in the documentation. I thought something based on lunr.js would work well.

While looking into it, I found that the docs are generated with docsaurus, but it's on v1 for which the only search option is a SaaS-based feature from algolia. in docsaurus v2 there are several plugins that build a local index that lunr.js can use. So I started down the process of trying to upgrade docsaurus to v2, but there are so many pieces and I don't know if I'm missing something. I've never used these libraries before.

If a project owner could offer some assistance I'd appreciate it. I'm happy to do most of the legwork but I don't want to put a bunch of time into this only to find that it's not the direction that the project owners want to take this. Help from non-project owners would be appreciated, too, esp. if you have experience with docsaurus.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions