Plugin Documentation
This report describes goals, parameters details, requirements and sample usage of this plugin.
Goals
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.
For Maven-2.x this is enabled by default only when the project has This default execution has been removed from the built-in lifecycle of Maven 3.x for |
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 , for the first locale. |
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, since local build directory structure doesn't match deployed site. |
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 work. This goal requires the site to already have been generated using the site goal, such as by calling |
site:stage-deploy | Deploys the generated site to a staging or mock URL to the site URL specified in the <distributionManagement> section of the POM, using wagon supported protocols |
System Requirements
The following specifies the minimum requirements to run this Maven plugin:
Maven | 3.6.3 |
JDK | 1.8 |
System Requirements History
The following specifies the minimum requirements to run this Maven plugin for historical versions:
Plugin Version | Maven | JDK |
---|---|---|
3.11.0 | 3.0.5 | 1.7 |
3.9.0 | 3.0 | 1.7 |
3.7.1 | 2.2.1 | 1.6 |
3.4 | 2.2.1 | 1.5 |
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>4.0.0-M15</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> </plugin> ... </plugins> </build> ... </project>
For more information, see "Guide to Configuring Plug-ins"