Plugin Documentation
Goals available for this plugin:
Goal | Description |
---|---|
site/search/offline:copy-ui-script | Copy a basic search script (Bootstrap friendly; requires JQuery, LunrJs and TypeAhead). For use with JsSearchIndexMojo |
site/search/offline:help | Display help information on io.earcam.maven.plugin.site.search.offline. Call mvn site/search/offline:help -Ddetail=true -Dgoal=<goal-name> to display parameter details. |
site/search/offline:index | Generate a lunr.js index for offline/static web search. |
System Requirements
The following specifies the minimum requirements to run this Maven plugin:
Maven | 2.0 |
JDK | 1.8 |
Memory | No minimum requirement. |
Disk Space | No minimum requirement. |
Usage
You should specify the version in your project's plugin configuration:
<project> ... <build> <!-- To define the plugin version in your parent POM --> <pluginManagement> <plugins> <plugin> <groupId>io.earcam.maven.plugin</groupId> <artifactId>io.earcam.maven.plugin.site.search.offline</artifactId> <version>0.0.4</version> </plugin> ... </plugins> </pluginManagement> <!-- To use the plugin goals in your POM or parent POM --> <plugins> <plugin> <groupId>io.earcam.maven.plugin</groupId> <artifactId>io.earcam.maven.plugin.site.search.offline</artifactId> <version>0.0.4</version> </plugin> ... </plugins> </build> ... </project>
For more information, see "Guide to Configuring Plug-ins"