site/search/offline:index
Full name:
io.earcam.maven.plugin:io.earcam.maven.plugin.site.search.offline:0.0.4:index
Description:
Generate a
lunr.js index for offline/static web search.
Attributes:
- Requires a Maven project to be executed.
- Binds by default to the lifecycle phase: site.
Required Parameters
| Name | Type | Since | Description |
|---|---|---|---|
| <outputCharset> | String | - | THe character encoding to use Default value is: ${project.reporting.outputEncoding}. |
Optional Parameters
| Name | Type | Since | Description |
|---|---|---|---|
| <crawler> | ConfigurationModel$Crawling | - | The crawler configuration ((useDefaultConfiguration must be false) |
| <indexer> | ConfigurationModel$Indexing | - | The indexer configuration ((useDefaultConfiguration must be false) |
| <skip> | boolean | - | Skip execution of this plugin Default value is: false. User property is: skip. |
| <useDefaultConfiguration> | boolean | - | Use the default settings for crawler and indexer (if true then crawler or indexer must not be specified) Default value is: true. |
Parameter Details
<crawler>
The crawler configuration ((
useDefaultConfiguration must be false)
- Type: io.earcam.utilitarian.site.search.offline.ConfigurationModel$Crawling
- Required: No
<indexer>
The indexer configuration ((
useDefaultConfiguration must be false)
- Type: io.earcam.utilitarian.site.search.offline.ConfigurationModel$Indexing
- Required: No
<outputCharset>
THe character encoding to use
- Type: java.lang.String
- Required: Yes
- Default: ${project.reporting.outputEncoding}
<useDefaultConfiguration>
Use the default settings for
crawler and
indexer (if true then
crawler or
indexer must not be specified)
- Type: boolean
- Required: No
- Default: true