site:run

Full name:

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

Description:

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

Attributes:

  • Requires a Maven project to be executed.
  • Executes only as a reportSet (reporting goal).
  • Executes as an aggregator plugin.

Optional Parameters

Name Type Since Description
attributes Map - Additional template properties for rendering the site. See Doxia Site Renderer.
generateProjectInfo boolean 2.3 Whether to generate the summary page for project reports: project-info.html.
Default value is: true.
User property is: generateProjectInfo.
generatedSiteDirectory File - Directory containing generated documentation. This is used to pick up other source docs that might have been generated at build time.
Default value is: ${project.build.directory}/generated-site.
inputEncoding String - Specifies the input encoding.
Default value is: ${project.build.sourceEncoding}.
User property is: encoding.
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.
User property is: locales.
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}.
User property is: outputEncoding.
relativizeDecorationLinks boolean 2.3 Make links in the site descriptor relative to the project URL. By default, any absolute links that appear in the site descriptor, e.g. banner hrefs, breadcrumbs, menu links, etc., will be made relative to project.url. Links will not be changed if this is set to false, or if the project has no URL defined.
Default value is: true.
User property is: relativizeDecorationLinks.
reportPlugins ReportPlugin[] 3.0-beta-1

Configuration section used internally by Maven 3.

More details available here: http://maven.apache.org/plugins/maven-site-plugin/maven-3.html#Configuration_formats

Note: using this field is not mandatory with Maven 3 as Maven core injects usual <reporting> section into this field.


siteDirectory File - Directory containing the site.xml file and the source for apt, fml and xdoc docs.
Default value is: ${basedir}/src/site.
tempWebappDirectory File - Where to create the dummy web application.
Default value is: ${project.build.directory}/site-webapp.
template String - Deprecated. use templateFile or skinning instead
User property is: template.
templateDirectory File - Deprecated. use templateFile or skinning instead
Default value is: src/site.
User property is: templateDirectory.
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.
User property is: templateFile.
xdocDirectory File - Deprecated. use the standard m2 directory layout
Default value is: ${basedir}/xdocs.

Parameter Details

attributes:

Additional template properties for rendering the site. See Doxia Site Renderer.
  • Type: java.util.Map
  • Required: No

generateProjectInfo:

Whether to generate the summary page for project reports: project-info.html.
  • Type: boolean
  • Since: 2.3
  • Required: No
  • User Property: generateProjectInfo
  • Default: true

generatedSiteDirectory:

Directory containing generated documentation. This is used to pick up other source docs that might have been generated at build time.
  • Type: java.io.File
  • Required: No
  • Default: ${project.build.directory}/generated-site

inputEncoding:

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

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
  • User Property: 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
  • User Property: outputEncoding
  • Default: ${project.reporting.outputEncoding}

relativizeDecorationLinks:

Make links in the site descriptor relative to the project URL. By default, any absolute links that appear in the site descriptor, e.g. banner hrefs, breadcrumbs, menu links, etc., will be made relative to project.url. Links will not be changed if this is set to false, or if the project has no URL defined.
  • Type: boolean
  • Since: 2.3
  • Required: No
  • User Property: relativizeDecorationLinks
  • Default: true

reportPlugins:

Configuration section used internally by Maven 3.

More details available here: http://maven.apache.org/plugins/maven-site-plugin/maven-3.html#Configuration_formats

Note: using this field is not mandatory with Maven 3 as Maven core injects usual <reporting> section into this field.

  • Type: org.apache.maven.reporting.exec.ReportPlugin[]
  • Since: 3.0-beta-1
  • Required: No

siteDirectory:

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

tempWebappDirectory:

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

template:

Deprecated. use templateFile or skinning instead
Default template page.
  • Type: java.lang.String
  • Required: No
  • User Property: template

templateDirectory:

Deprecated. use templateFile or skinning instead
Directory containing the template page.
  • Type: java.io.File
  • Required: No
  • User Property: 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
  • User Property: 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