Apache Maven Site Plugin

site:run

Full name:

org.apache.maven.plugins:maven-site-plugin:3.11.0: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.
Since version: 3.5.

Optional Parameters

Name	Type	Since	Description
`<attributes>`	`Map`	`3.5`	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`	`3.5`	Directory containing generated documentation in source format (Doxia supported markup). This is used to pick up other source docs that might have been generated at build time (by reports or any other build time mean). This directory is expected to have the same structure as `siteDirectory` (ie. one directory per Doxia-source-supported markup types). todo should we deprecate in favour of reports directly using Doxia Sink API, without this Doxia source intermediate step? Default value is: `${project.build.directory}/generated-site`. Alias is: `workingDirectory`.
`<inputEncoding>`	`String`	`2.3`	Specifies the input encoding. Default value is: `${project.build.sourceEncoding}`. User property is: `encoding`.
`<locales>`	`String`	`2.3`	A comma separated list of locales to render. The first valid token will be the default Locale for this site. Default value is: `en`. User property is: `locales`.
`<moduleExcludes>`	`Map`	`3.5`	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`	`2.3`	Specifies the output encoding. Default value is: `${project.reporting.outputEncoding}`. User property is: `outputEncoding`.
`<port>`	`int`	`3.5`	The port to execute the HTTP server on. Default value is: `8080`. User property is: `port`.
`<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`.
`<saveProcessedContent>`	`boolean`	`3.5`	Whether to save Velocity processed Doxia content (`*.<ext>.vm`) to `${generatedSiteDirectory}/processed`.
`<siteDirectory>`	`File`	`2.3`	Directory containing the `site.xml` file and the source for hand written docs (one directory per Doxia-source-supported markup types): see Doxia Markup Languages References). Default value is: `${basedir}/src/site`.
`<skip>`	`boolean`	`3.0`	Set this to 'true' to skip site generation and staging. Default value is: `false`. User property is: `maven.site.skip`.
`<tempWebappDirectory>`	`File`	`3.5`	Where to create the dummy web application. Default value is: `${project.build.directory}/site-webapp`.
`<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`	`3.5`	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
Since: 3.5
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

Directory containing generated documentation in source format (Doxia supported markup). This is used to pick up other source docs that might have been generated at build time (by reports or any other build time mean). This directory is expected to have the same structure as siteDirectory (ie. one directory per Doxia-source-supported markup types). todo should we deprecate in favour of reports directly using Doxia Sink API, without this Doxia source intermediate step?

Type: java.io.File
Since: 3.5
Required: No
Default: ${project.build.directory}/generated-site
Alias: workingDirectory

<inputEncoding>

Specifies the input encoding.

Type: java.lang.String
Since: 2.3
Required: No
User Property: encoding
Default: ${project.build.sourceEncoding}

<locales>

A comma separated list of locales to render. The first valid token will be the default Locale for this site.

Type: java.lang.String
Since: 2.3
Required: No
User Property: locales
Default: en

<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
Since: 3.5
Required: No

<outputEncoding>

Specifies the output encoding.

Type: java.lang.String
Since: 2.3
Required: No
User Property: outputEncoding
Default: ${project.reporting.outputEncoding}

<port>

The port to execute the HTTP server on.

Type: int
Since: 3.5
Required: No
User Property: port
Default: 8080

<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

<saveProcessedContent>

Whether to save Velocity processed Doxia content (*.<ext>.vm) to ${generatedSiteDirectory}/processed.

Type: boolean
Since: 3.5
Required: No

<siteDirectory>

Directory containing the site.xml file and the source for hand written docs (one directory per Doxia-source-supported markup types): see Doxia Markup Languages References).

Type: java.io.File
Since: 2.3
Required: No
Default: ${basedir}/src/site

<skip>

Set this to 'true' to skip site generation and staging.

Type: boolean
Since: 3.0
Required: No
User Property: maven.site.skip
Default: false

<tempWebappDirectory>

Where to create the dummy web application.

Type: java.io.File
Since: 3.5
Required: No
Default: ${project.build.directory}/site-webapp

<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
Since: 3.5
Required: No
Default: ${basedir}/xdocs