Goals available for this plugin:
| Goal | Description |
|---|---|
| site:attach-descriptor | Adds the site descriptor (site.xml) to the list of
files to be installed/deployed. |
| site:deploy | Deploys the generated site using wagon supported
protocols to the site URL specified in the
<distributionManagement> section of the POM.
For |
| site:effective-site | Displays the effective site descriptor as an XML for this build,
after inheritance and interpolation of site.xml. |
| site:help | Display help information on maven-site-plugin. Call mvn site:help -Ddetail=true -Dgoal=<goal-name>to display parameter details. |
| site:jar | Bundles the site output into a JAR so that it can be deployed to a repository. |
| site:run | Starts the site up, rendering documents as requested for faster editing. It uses Jetty as the web server. |
| site:site | Generates the site for a single project.
Note that links between module sites in a multi module build will not work. |
| site:stage | Deploys the generated site to a local staging or mock directory
based on the site URL specified in the
<distributionManagement> section of the POM.
It can be used to test that links between module sites in a multi-module build works. |
| site:stage-deploy | Deploys the generated site to a staging or mock directory to the
site URL specified in the
<distributionManagement> section of the POM,
using wagon supported protocols |
The following specifies the minimum requirements to run this Maven plugin:
| Maven | 2.2.0 |
| JDK | 1.5 |
| Memory | No minimum requirement. |
| Disk Space | No minimum requirement. |
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>org.apache.maven.plugins</groupId>
<artifactId>maven-site-plugin</artifactId>
<version>2.4</version>
</plugin>
...
</plugins>
</pluginManagement>
<!-- To use the plugin goals in your POM or parent POM -->
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-site-plugin</artifactId>
<version>2.4</version>
</plugin>
...
</plugins>
</build>
...
</project>
For more information, see "Guide to Configuring Plug-ins"