site:effective-site
Full name:
org.apache.maven.plugins:maven-site-plugin:3.12.1:effective-site
Description:
Displays the effective site descriptor as an XML for this build,
after inheritance and interpolation of
site.xml, for
the first locale.Attributes:
- Requires a Maven project to be executed.
- Executes only as a reportSet (reporting goal).
- The goal is not marked as thread-safe and thus does not support parallel builds.
- Since version:
2.2.
Optional Parameters
| Name | Type | Since | Description |
|---|---|---|---|
<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. |
<output> |
File |
2.2 |
Optional parameter to write the output of this help in a given
file, instead of writing to the console.
Note: Could be a relative path. User property is: output. |
<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. |
<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. |
Parameter Details
<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
<output>
Optional parameter to write the output of this help in a given
file, instead of writing to the console.
Note: Could be a relative path.
- Type:
java.io.File - Since:
2.2 - Required:
No - User Property:
output
<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
<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