site:run

Full name:

org.apache.maven.plugins:maven-site-plugin:2.1.1:run

Description:

Starts the site up, rendering documents as requested for faster editing. It uses Jetty as the web server.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Executes as an aggregator plugin.

Required Parameters

Name Type Since Description
generatedSiteDirectory File - Directory containing generated documentation.
siteDirectory File - Directory containing the site.xml file and the source for apt, fml and xdoc docs.

Optional Parameters

Name Type Since Description
attributes Map - The template properties for rendering the site.
inputEncoding String - Specifies the input encoding.
Default value is: ${project.build.sourceEncoding}.
localRepository ArtifactRepository - The local repository.
locales String - A comma separated list of locales supported by Maven. The first valid token will be the default Locale for this instance of the Java Virtual Machine.
moduleExcludes Map - Module type exclusion mappings ex: fml -> **/*-m1.fml (excludes fml files ending in '-m1.fml' recursively)

The configuration looks like this: 
  <moduleExcludes>
    <moduleType>filename1.ext,**/*sample.ext</moduleType>
    <!-- moduleType can be one of 'apt', 'fml' or 'xdoc'. -->
    <!-- The value is a comma separated list of           -->
    <!-- filenames or fileset patterns.                   -->
    <!-- Here's an example:                               -->
    <xdoc>changes.xml,navigation.xml</xdoc>
  </moduleExcludes>

outputEncoding String - Specifies the output encoding.
Default value is: ${project.reporting.outputEncoding}.
port int - The port to execute the HTTP server on.
Default value is: 8080.
repositories List - Remote repositories used for the project.
tempWebappDirectory File - Where to create the dummy web application.
template String - Deprecated. use templateFile or skinning instead
templateDirectory File - Deprecated. use templateFile or skinning instead
Default value is: src/site.
templateFile File 2.0-beta-5 The location of a Velocity template file to use. When used, skins and the default templates, CSS and images are disabled. It is highly recommended that you package this as a skin instead.
xdocDirectory File - Deprecated. use the standard m2 directory layout
Default value is: ${basedir}/xdocs.

Parameter Details

attributes:

The template properties for rendering the site.
  • Type: java.util.Map
  • Required: No
  • Expression: ${attributes}

generatedSiteDirectory:

Directory containing generated documentation.
  • Type: java.io.File
  • Required: Yes
  • Expression: ${project.build.directory}/generated-site

inputEncoding:

Specifies the input encoding.
  • Type: java.lang.String
  • Required: No
  • Expression: ${encoding}
  • Default: ${project.build.sourceEncoding}

localRepository:

The local repository.
  • Type: org.apache.maven.artifact.repository.ArtifactRepository
  • Required: No
  • Expression: ${localRepository}

locales:

A comma separated list of locales supported by Maven. The first valid token will be the default Locale for this instance of the Java Virtual Machine.
  • Type: java.lang.String
  • Required: No
  • Expression: ${locales}

moduleExcludes:

Module type exclusion mappings ex: fml -> **/*-m1.fml (excludes fml files ending in '-m1.fml' recursively)

The configuration looks like this: 
  <moduleExcludes>
    <moduleType>filename1.ext,**/*sample.ext</moduleType>
    <!-- moduleType can be one of 'apt', 'fml' or 'xdoc'. -->
    <!-- The value is a comma separated list of           -->
    <!-- filenames or fileset patterns.                   -->
    <!-- Here's an example:                               -->
    <xdoc>changes.xml,navigation.xml</xdoc>
  </moduleExcludes>
  • Type: java.util.Map
  • Required: No

outputEncoding:

Specifies the output encoding.
  • Type: java.lang.String
  • Required: No
  • Expression: ${outputEncoding}
  • Default: ${project.reporting.outputEncoding}

port:

The port to execute the HTTP server on.
  • Type: int
  • Required: No
  • Expression: ${port}
  • Default: 8080

repositories:

Remote repositories used for the project.
  • Type: java.util.List
  • Required: No
  • Expression: ${project.remoteArtifactRepositories}

siteDirectory:

Directory containing the site.xml file and the source for apt, fml and xdoc docs.
  • Type: java.io.File
  • Required: Yes
  • Expression: ${basedir}/src/site

tempWebappDirectory:

Where to create the dummy web application.
  • Type: java.io.File
  • Required: No
  • Expression: ${project.build.directory}/site-webapp

template:

Deprecated. use templateFile or skinning instead
Default template page.
  • Type: java.lang.String
  • Required: No
  • Expression: ${template}

templateDirectory:

Deprecated. use templateFile or skinning instead
Directory containing the template page.
  • Type: java.io.File
  • Required: No
  • Expression: ${templateDirectory}
  • Default: src/site

templateFile:

The location of a Velocity template file to use. When used, skins and the default templates, CSS and images are disabled. It is highly recommended that you package this as a skin instead.
  • Type: java.io.File
  • Since: 2.0-beta-5
  • Required: No
  • Expression: ${templateFile}

xdocDirectory:

Deprecated. use the standard m2 directory layout
Alternative directory for xdoc source, useful for m1 to m2 migration
  • Type: java.io.File
  • Required: No
  • Default: ${basedir}/xdocs