Plugin Documentation

Goals available for this plugin:

GoalDescription
site:attach-descriptorAdds the site descriptor (site.xml) to the list of files to be installed/deployed.
site:deployDeploys the generated site using scp or file protocol to the site URL specified in the <distributionManagement> section of the POM.

For scp protocol, the website files are packaged into zip archive, then the archive is transfered to the remote host, next it is un-archived. This method of deployment should normally be much faster than making a file by file copy. For file protocol, the files are copied directly to the destination directory.

site:effective-siteDisplays the effective site descriptor as an XML for this build, after inheritance and interpolation of site.xml.
site:helpDisplay help information on maven-site-plugin.
Call 
  mvn site:help -Ddetail=true -Dgoal=<goal-name>
to display parameter details.
site:jarBundles the site output into a JAR so that it can be deployed to a repository.
site:runStarts the site up, rendering documents as requested for faster editing. It uses Jetty as the web server.
site:siteGenerates the site for a single project.

Note that links between module sites in a multi module build will not work.

site:stageGenerates a site in 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-deployDeploys the generated site to a staging or mock directory to the site URL specified in the <distributionManagement> section of the POM. It supports scp and file protocols for deployment.

System Requirements

The following specifies the minimum requirements to run this Maven plugin:

Maven2.2.0
JDK1.5
MemoryNo minimum requirement.
Disk SpaceNo 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>org.apache.maven.plugins</groupId>
          <artifactId>maven-site-plugin</artifactId>
          <version>2.3</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.3</version>
      </plugin>
      ...
    </plugins>
  </build>
  ...
</project>

For more information, see "Guide to Configuring Plug-ins"