Built by Maven

site:site

Full name:

org.apache.maven.plugins:maven-site-plugin:3.9.0:site

Description:

Generates the site for a single project.

Note that links between module sites in a multi module build will not work, since local build directory structure doesn't match deployed site.

Attributes:

  • Requires a Maven project to be executed.
  • Executes only as a reportSet (reporting goal).
  • Requires dependency resolution of artifacts in scope: test.
  • 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.
<generateReports> boolean 3.5 Convenience parameter that allows you to disable report generation.
Default value is: true.
User property is: generateReports.
<generateSitemap> boolean 2.1 Generate a sitemap. The result will be a "sitemap.html" file at the site root.
Default value is: false.
User property is: generateSitemap.
<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).
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>

<outputDirectory> File 3.5 Directory where the project sites and report distributions will be generated (as html/css/...).
Default value is: ${project.reporting.outputDirectory}.
User property is: siteOutputDirectory.
<outputEncoding> String 2.3 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.
<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.
<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.
<validate> boolean 2.1.1 Whether to validate xml input documents. If set to true, all input documents in xml format (in particular xdoc and fml) will be validated and any error will lead to a build failure.
Default value is: false.
User property is: validate.
<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

<generateReports>

Convenience parameter that allows you to disable report generation.
  • Type: boolean
  • Since: 3.5
  • Required: No
  • User Property: generateReports
  • 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).
  • 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

<outputDirectory>

Directory where the project sites and report distributions will be generated (as html/css/...).
  • Type: java.io.File
  • Since: 3.5
  • Required: No
  • User Property: siteOutputDirectory
  • Default: ${project.reporting.outputDirectory}

<outputEncoding>

Specifies the output encoding.
  • Type: java.lang.String
  • Since: 2.3
  • 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

<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

<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

<validate>

Whether to validate xml input documents. If set to true, all input documents in xml format (in particular xdoc and fml) will be validated and any error will lead to a build failure.
  • Type: boolean
  • Since: 2.1.1
  • Required: No
  • User Property: validate
  • Default: false

<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