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 report distributions that was configured in the <reporting> section of the pom.

Goals Overview

The Site Plugin has six goals:

  • 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: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 http://maven.apache.org/site.html.
  • site:site is used generate a site for the project.
  • site:run starts the site up, rendering documents as requested for faster editing. It uses Jetty for the webapp server.
  • site:stage-deploy deploys the generated site in a staging or mock directory on the site specified in the <distributionManagement> section of the pom. It also supports scp and file protocol for deployment.
  • site:stage generate a site in a local staging or mock directory based on the site url specified in the <distributionManagement> section of the pom.

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: