antora-site-generator-lunr
Advanced tools
This site generator is a copy of the default site generator that in addition produces a Lunr index that can be used in your documentation UI. Lunr provides a great search experience in your documentation site without the need for external, server-side, search services.
Antora is a modular static site generator designed for creating documentation sites from AsciiDoc documents. Its site generator pipeline aggregates documents from versioned content repositories and processes them using Asciidoctor.
Install the site generator. Open a terminal and type:
$ npm i antora-site-generator-lunr
NOTE: If Antora is installed globally, you should also add this module globally using the -g flag:
$ npm i -g antora-site-generator-lunr
When generating your documentation site, use the --generator option:
$ DOCSEARCH_ENABLED=true DOCSEARCH_ENGINE=lunr antora site.yml --generator antora-site-generator-lunr
Please read the documentation to enable the search component in your documentation UI.
FAQs
An Antora's site generator that produces a Lunr index.
The npm package antora-site-generator-lunr receives a total of 1,020 weekly downloads. As such, antora-site-generator-lunr popularity was classified as popular.
We found that antora-site-generator-lunr demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
pnpm 10 blocks lifecycle scripts by default to improve security, addressing supply chain attack risks but sparking debate over compatibility and workflow changes.
Product
Socket now supports uv.lock files to ensure consistent, secure dependency resolution for Python projects and enhance supply chain security.
Research
Security News
Socket researchers have discovered multiple malicious npm packages targeting Solana private keys, abusing Gmail to exfiltrate the data and drain Solana wallets.