Skip to content

JBang documentation search functionality: Algolia vs Antora's lunr-extension. #2367

@wfouche

Description

@wfouche

Algolia search is meant for very large documentation sites and seems a bit overkill for JBang's documentation. Currently, the search functionality is not picking up several search keywords like JBANG_JAVA_OPTIONS, etc.

The @antora/lunr-extension is the "official" way to add search to Antora 3.x:

  • Build Integration: You add the extension to your antora-playbook.yml.

  • Automatic Indexing: Every time you run the antora command, it automatically looks at your AsciiDoc files and creates the search index.

  • No Configuration: It "just works" with the default Antora UI and requires no external accounts or API keys.

I believe that @antora/lunr-extension will provide a better search experience for JBang users.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions