Example
The following is a simple example of how to use the plugin:
By default, the
maven-site-plugin is bound to the Maven
site lifecycle phase, so it's generally preferred to disable the plugin by explicitly binding it to the
none phase. The
minisite plugin is intended for use with multi-module builds and is designed to run at most once for the parent module, in contrast to the once-per-module execution model of the
maven-site-plugin. It's therefore recommended to set
inherited to
false as shown so that the plugin won't execute for any child modules.
The overviewFile parameter specifies an XHTML file that will be inserted into the overview section of the generated site.
The featuresFile parameter specifies an XHTML file that will be inserted into the features section of the generated site.
The
changelogFile parameter specifies an XML changelog in
changelog format that will be converted into XHTML for the generated site. If no file is specified, no
changes section will be generated.
The changelogFeedEmail parameter the email address that will be used when generating an RSS feed for the changelog.
The outputDirectory parameter specifies the directory to which site files will be generated, and resources copied. This parameter is optional and defaults to {project.build.directory}/minisite.
The resourcesDirectory parameter specifies the directory from which site resources will be copied copied. This parameter is optional and defaults to {project.base.directory}/src/site/resources.
The documentation parameter specifies documentation. It takes a list of DocumentationItem values as parameters. Each DocumentationItem specifies a name and a list of DocumentationFormat values. Each DocumentationFormat value specifies a format name and a path. The usage example above specifies a single documentation item that has three formats: Single-page XHTML placed at /documentation/index.xhtml, multi-page XHTML placed at /documentation/index-m.xhtml, and plain text placed at /documentation/main.txt.