Apache Maven 站点插件 – 站点：站点

站点：站点

全名：

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

说明：

为单个项目生成站点。

请注意，多模块构建中的模块站点之间的链接将不起作用，因为本地构建目录结构与部署的站点不匹配。

属性：

需要执行一个 Maven 项目。
仅作为报告集（报告目标）执行。
需要对范围内的工件进行依赖解析：test。
自版本：3.5。

可选参数

姓名	类型	自从	描述
`<属性>`	`地图`	`3.5`	用于呈现站点的其他模板属性。请参阅Doxia 站点渲染器。
`<生成项目信息>`	`布尔值`	`2.3`	是否生成项目报告的摘要页：project-info.html。默认值为：`true`。用户属性是：`generateProjectInfo`。
`<生成报告>`	`布尔值`	`3.5`	允许您禁用报告生成的便利参数。默认值为：`true`。用户属性是：`generateReports`。
`<生成站点地图>`	`布尔值`	`2.1`	生成站点地图。结果将是站点根目录中的“sitemap.html”文件。默认值为：`false`。用户属性是：`generateSitemap`。
`<生成的站点目录>`	`文件`	`3.5`	包含源格式生成文档的目录（Doxia 支持的标记）。这用于获取可能在构建时生成的其他源文档（通过报告或任何其他构建时间的平均值）。`该目录应该与siteDirectory`具有相同的结构（即每个 Doxia 源支持的标记类型一个目录）。我们是否应该弃用直接使用 Doxia Sink API 的报告，而不使用 Doxia 源中间步骤？默认值为：`${project.build.directory}/generated-site`。别名是：`workingDirectory`。
`<输入编码>`	`细绳`	`2.3`	指定输入编码。默认值为：`${project.build.sourceEncoding}`。用户属性是：`编码`。
`<语言环境>`	`细绳`	`2.3`	要呈现的以逗号分隔的语言环境列表。第一个有效令牌将是该站点的默认语言环境。默认值为：`en`。用户属性是：`locales`。
`<模块排除>`	`地图`	`3.5`	模块类型排除映射例如：`fml -> */-m1.fml`（递归排除以 '-m1.fml' 结尾的 fml 文件）配置如下所示： <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>
`<输出目录>`	`文件`	`3.5`	将生成项目站点和报告分发的目录（如 html/css/...）。默认值为：`${project.reporting.outputDirectory}`。用户属性是：`siteOutputDirectory`。
`<输出编码>`	`细绳`	`2.3`	指定输出编码。默认值为：`${project.reporting.outputEncoding}`。用户属性是：`outputEncoding`。
`<relativizeDecorationLinks>`	`布尔值`	`2.3`	在站点描述符中创建相对于项目 URL 的链接。默认情况下，出现在站点描述符中的任何绝对链接，例如横幅 href、面包屑、菜单链接等，都将相对于 project.url。如果设置为 false，或者项目没有定义 URL，则不会更改链接。默认值为：`true`。用户属性是：`relativizeDecorationLinks`。
`<保存处理内容>`	`布尔值`	`3.5`	是否将 Velocity 处理的 Doxia 内容 ( `*.<ext>.vm` ) 保存到 `${generatedSiteDirectory}/processed`。
`<站点目录>`	`文件`	`2.3`	包含`site.xml`文件和手写文档源的目录（每个 Doxia 源支持的标记类型一个目录）：请参阅Doxia 标记语言参考）。默认值为：`${basedir}/src/site`。
`<跳过>`	`布尔值`	`3.0`	将此设置为“true”以跳过站点生成和登台。默认值为：`false`。用户属性是：`maven.site.skip`。
`<模板文件>`	`文件`	`2.0-beta-5`	要使用的 Velocity 模板文件的位置。使用时，皮肤和默认模板、CSS 和图像被禁用。强烈建议您将其打包为皮肤。用户属性是：`templateFile`。
`<验证>`	`布尔值`	`2.1.1`	是否验证 xml 输入文档。如果设置为 true，所有xml 格式的输入文档（特别是 xdoc 和 fml）都将被验证，任何错误都将导致构建失败。默认值为：`false`。用户属性是：`验证`。
`<xdoc目录>`	`文件`	`3.5`	已弃用。使用标准 m2 目录布局默认值为：`${basedir}/xdocs`。

参数详情

<属性>

用于呈现站点的其他模板属性。请参阅Doxia 站点渲染器。

类型：java.util.Map
从: 3.5
要求：否

<生成项目信息>

是否生成项目报告的摘要页：project-info.html。

类型：布尔值
从: 2.3
要求：否
用户属性：generateProjectInfo
默认值：真

<生成报告>

允许您禁用报告生成的便利参数。

类型：布尔值
从: 3.5
要求：否
用户属性：generateReports
默认值：真

<生成站点地图>

生成站点地图。结果将是站点根目录中的“sitemap.html”文件。

类型：布尔值
从: 2.1
要求：否
用户属性：generateSitemap
默认值：假

<生成的站点目录>

包含源格式生成文档的目录（Doxia 支持的标记）。这用于获取可能在构建时生成的其他源文档（通过报告或任何其他构建时间的平均值）。该目录应该与siteDirectory具有相同的结构（即每个 Doxia 源支持的标记类型一个目录）。我们是否应该弃用直接使用 Doxia Sink API 的报告，而不使用 Doxia 源中间步骤？

类型：java.io.File
从: 3.5
要求：否
默认：${project.build.directory}/generated-site
别名：工作目录

<输入编码>

指定输入编码。

类型：java.lang.String
从: 2.3
要求：否
用户属性：编码
默认值：${project.build.sourceEncoding}

<语言环境>

要呈现的以逗号分隔的语言环境列表。第一个有效令牌将是该站点的默认语言环境。

类型：java.lang.String
从: 2.3
要求：否
用户属性：语言环境
默认值：en

<模块排除>

模块类型排除映射例如：fml -> **/*-m1.fml（递归排除以 '-m1.fml' 结尾的 fml 文件）配置如下所示：

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