Sentry Maven Skin 6.4.01
-
Home
- User Documentation Features 14
Index and Search
The Sentry Maven Skin includes complete search capabilities within the documentation and doesn't rely on external search engines like Google. Readers can search the documentation very easily.
Search also works on mobile:
How does it work?
The content of each page is automatically indexed with elasticlunr.js[1]. Elasticlunr.js is a Javascript front-end only indexing and searching solution.
The Sentry Maven Skin will build an Elasticlunr.js index and each page will be able to search the entire project documentation. The Elasticlunr.js indexer is executed by the Sentry Maven Skin using GraalVM's JavaScript engine[2]. Then the Elasticlunr.js client is loaded as part of the AngularJS app running on each page.
The index file is target/site/index.json and can be leveraged and merged with other documentation indexes, but this will require extra work (in Javascript only).
The index.json file is lazily loaded when the user starts typing in the Search box. Its size grows with the size of the documentation.