Apache Maven Site Plugin

site:run

Full name:

org.apache.maven.plugins:maven-site-plugin:3.21.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).
Requires dependency resolution of artifacts in scope: test.
The goal is not marked as thread-safe and thus does not support parallel builds.
Since version: 3.5.

Optional Parameters

Name	Type	Since	Description
`<attributes>`	`Map<String,Object>`	`-`	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: `true` User Property: `generateProjectInfo`
`<generateSitemap>`	`boolean`	`2.1`	Generate a sitemap. The result will be a "sitemap.html" file at the site root. Default: `false` User Property: `generateSitemap`
`<generatedSiteDirectory>`	`File`	`-`	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: `${project.build.directory}/generated-site` Alias: `workingDirectory`
`<host>`	`String`	`-`	The host to execute the HTTP server on. Default: `localhost` User Property: `host`
`<inputEncoding>`	`String`	`2.3`	Specifies the input encoding. Default: `${project.build.sourceEncoding}` User Property: `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: `default` User Property: `locales`
`<moduleExcludes>`	`Map<String,String>`	`-`	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: `${project.reporting.outputEncoding}` User Property: `outputEncoding`
`<outputTimestamp>`	`String`	`3.9.0`	Timestamp for reproducible output archive entries, either formatted as ISO 8601 `yyyy-MM-dd'T'HH:mm:ssXXX` or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH). Default: `${project.build.outputTimestamp}`
`<port>`	`int`	`-`	The port to execute the HTTP server on. Default: `8080` User Property: `port`
`<relativizeSiteLinks>`	`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: `true` User Property: `relativizeSiteLinks`
`<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: `${basedir}/src/site`
`<skip>`	`boolean`	`3.0`	Set this to 'true' to skip site generation and staging. Default: `false` User Property: `maven.site.skip`
`<tempWebappDirectory>`	`File`	`-`	Where to create the dummy web application. Default: `${project.build.directory}/site-webapp`

Parameter Details

<attributes>

Additional template properties for rendering the site. See Doxia Site Renderer.

Type: java.util.Map<java.lang.String, java.lang.Object>
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

<generateSitemap>

Generate a sitemap. The result will be a "sitemap.html" file at the site root.

Type: boolean
Since: 2.1
Required: No
User Property: generateSitemap
Default: false

<generatedSiteDirectory>

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
Required: No
Default: ${project.build.directory}/generated-site
Alias: workingDirectory

<host>

The host to execute the HTTP server on.

Type: java.lang.String
Required: No
User Property: host
Default: localhost

<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: default

<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<java.lang.String, java.lang.String>
Required: No

<outputEncoding>

Specifies the output encoding.

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

<outputTimestamp>

Timestamp for reproducible output archive entries, either formatted as ISO 8601 yyyy-MM-dd'T'HH:mm:ssXXX or as an int representing seconds since the epoch (like SOURCE_DATE_EPOCH).

Type: java.lang.String
Since: 3.9.0
Required: No
Default: ${project.build.outputTimestamp}

<port>

The port to execute the HTTP server on.

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

<relativizeSiteLinks>

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: relativizeSiteLinks
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
Required: No
Default: ${project.build.directory}/site-webapp