site:site – Apache Maven Site Plugin (original) (raw)

Full name:

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

Description:

Generates the site for a single project.

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

Attributes:

Optional Parameters

Name Type Since Description
File[] 3.22.0 Optional list of source directories to be used instead of org.apache.maven.plugins.site.descriptor.AbstractSiteDescriptorMojo.siteDirectory for rendering edit URLs. This is only used for documents rendered from org.apache.maven.plugins.site.descriptor.AbstractSiteDescriptorMojo.siteDirectory but not for those rendered from generatedSiteDirectory. as the latter ones are always considered non-editable. The first directory containing a document with the given relative path is used for generating the URL (the same relative path as the document has to org.apache.maven.plugins.site.descriptor.AbstractSiteDescriptorMojo.siteDirectory).
Map<String,Object> - Additional template properties for rendering the site. See Doxia Site Renderer.
boolean 2.3 Whether to generate the summary page for project reports: project-info.html.Default: trueUser Property: generateProjectInfo
boolean - Convenience parameter that allows you to disable report generation.Default: trueUser Property: generateReports
boolean 2.1 Generate a sitemap. The result will be a "sitemap.html" file at the site root.Default: falseUser Property: generateSitemap
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). This is never editable.Default: ${project.build.directory}/generated-siteAlias: workingDirectory
String 2.3 Specifies the input encoding.Default: ${project.build.sourceEncoding}User Property: encoding
String 2.3 A comma separated list of locales to render. The first valid token will be the default Locale for this site.Default: defaultUser Property: locales
Map<String,String> - Module type exclusion mappings ex: fml -> **/*-m1.fml (excludes fml files ending in '-m1.fml' recursively) The configuration looks like this: filename1.ext,**/*sample.ext changes.xml,navigation.xml
File - Directory where the project sites and report distributions will be generated (as html/css/...).Default: ${project.reporting.outputDirectory}User Property: siteOutputDirectory
String 2.3 Specifies the output encoding.Default: ${project.reporting.outputEncoding}User Property: outputEncoding
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}
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: trueUser Property: relativizeSiteLinks
boolean 3.5 Whether to save Velocity processed Doxia content (*..vm) to ${generatedSiteDirectory}/processed.
File 2.3 Directory containing the site.xml file and the source for handwritten docs (one directory per Doxia-source-supported markup types): see Doxia Markup Languages References.Default: ${basedir}/src/site
boolean 3.0 Set this to 'true' to skip site generation and staging.Default: falseUser Property: maven.site.skip
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: falseUser Property: validate

Parameter Details

Optional list of source directories to be used instead of org.apache.maven.plugins.site.descriptor.AbstractSiteDescriptorMojo.siteDirectory for rendering edit URLs. This is only used for documents rendered from org.apache.maven.plugins.site.descriptor.AbstractSiteDescriptorMojo.siteDirectory but not for those rendered from generatedSiteDirectory. as the latter ones are always considered non-editable. The first directory containing a document with the given relative path is used for generating the URL (the same relative path as the document has to org.apache.maven.plugins.site.descriptor.AbstractSiteDescriptorMojo.siteDirectory).

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

Whether to generate the summary page for project reports: project-info.html.

Convenience parameter that allows you to disable report generation.

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

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). This is never editable.

Specifies the input encoding.

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

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

The configuration looks like this:

filename1.ext,**/*sample.ext changes.xml,navigation.xml

Directory where the project sites and report distributions will be generated (as html/css/...).

Specifies the output encoding.

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).

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.

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

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

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

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.