Full-Text Search

Sentry Maven Skin includes built-in full-text search - no Google or external services required.

Search results with highlighted matches

Works great on mobile too:

inline

How It Works

  1. During build, all pages are indexed using elasticlunr.js[1]
  2. The index is saved to target/site/index.json
  3. When users search, the index loads and results appear instantly

The indexer runs on GraalVM's JavaScript engine[2] during the Maven build.

Features

  • Instant results as you type
  • Highlighted excerpts showing matching text
  • Relevance scoring for result ranking
  • No external dependencies - works offline
  • Lazy loading - index loads only when needed

Configuration

Search works automatically with no configuration needed.

Setting Description Default
buildIndex Include page in search index true

To exclude specific pages from the search index:

Site-Wide (site.xml)

Site-Wide (site.xml)

<custom>
  <buildIndex>false</buildIndex>
</custom>

This removes both the search index generation and the search UI from all pages.

Per-Page (Frontmatter)

Per-Page (Frontmatter)

buildIndex: false

# Internal Notes

This page won't appear in search results.

The search UI remains visible on that page.

Index Size

Tip

The index.json file size grows with your documentation size. For very large sites, consider excluding auto-generated pages or verbose API documentation from the index.

See Also

Searching...
No results.