Maven 2 Site Plugin
The Maven 2 Site Plugin is used to generate a site for the project. The generated site also includes the project's reports that were configured in the <reporting>
section of the POM.
Goals Overview
The Site Plugin has seven goals:
- site:site
is used generate a site for a single project. Note that links between module sites in a multi module build will not
work.
- site:deploy
is used to deploy the generated site using scp
or file
protocol to the site specified in the <distributionManagement>
section of the POM.
- site:run
starts the site up, rendering documents as requested for faster editing. It uses Jetty as the web server.
- site:stage
generates 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-deploy
deploys the generated site to a staging or mock directory on the site specified in the <distributionManagement>
section of the POM. It also supports scp
and file
protocols for deployment.
- site:attach-descriptor
adds the site descriptor to the list of files to be installed/deployed. For more references of the site descriptor, here's a link
.
- site:jar
is used to bundle the site output into a jar.
Usage
Instructions on how to use the Site Plugin can be found here
.
Examples
The following examples show how to use the Site Plugin in more advanced usecases:
