Apache Maven 站点插件

站点：运行

全名：

org.apache.maven.plugins:maven-site-plugin:3.4:run

说明：

启动站点，根据要求呈现文档以加快编辑速度。它使用 Jetty 作为 Web 服务器。

属性：

需要执行一个 Maven 项目。
仅作为报告集（报告目标）执行。
作为聚合器插件执行。

可选参数

姓名	类型	自从	描述
属性	`地图`	`-`	用于呈现站点的其他模板属性。请参阅Doxia 站点渲染器。
生成项目信息	`布尔值`	`2.3`	是否生成项目报告的摘要页：project-info.html。默认值为：`true`。用户属性是：`generateProjectInfo`。
生成的站点目录	`文件`	`-`	包含生成文档的目录。这用于获取可能在构建时生成的其他源文档。默认值为：`${project.build.directory}/generated-site`。
输入编码	`细绳`	`2.3`	指定输入编码。默认值为：`${project.build.sourceEncoding}`。用户属性是：`编码`。
语言环境	`细绳`	`2.3`	Maven 支持的以逗号分隔的语言环境列表。第一个有效令牌将是此 Java 虚拟机实例的默认语言环境。用户属性是：`locales`。
mavenSession	`Maven会话`	`-`	当前的 Maven 会话。默认值为：`${session}`。
模块排除	`地图`	`-`	模块类型排除映射例如：`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>
输出编码	`细绳`	`2.3`	指定输出编码。默认值为：`${project.reporting.outputEncoding}`。用户属性是：`outputEncoding`。
港口	`整数`	`-`	执行 HTTP 服务器的端口。默认值为：`8080`。用户属性是：`端口`。
相对化装饰链接	`布尔值`	`2.3`	在站点描述符中创建相对于项目 URL 的链接。默认情况下，出现在站点描述符中的任何绝对链接，例如横幅 href、面包屑、菜单链接等，都将相对于 project.url。如果设置为 false，或者项目没有定义 URL，则不会更改链接。默认值为：`true`。用户属性是：`relativizeDecorationLinks`。
站点目录	`文件`	`2.3`	包含 site.xml 文件和 apt、fml 和 xdoc 文档源的目录。默认值为：`${basedir}/src/site`。
tempWebapp目录	`文件`	`-`	在哪里创建虚拟 Web 应用程序。默认值为：`${project.build.directory}/site-webapp`。
模板	`细绳`	`-`	已弃用。使用 templateFile 或换肤 User 属性是：`模板`。
模板目录	`文件`	`-`	已弃用。使用 templateFile 或 skinning 代替默认值是：`src/site`。用户属性是：`templateDirectory`。
模板文件	`文件`	`2.0-beta-5`	要使用的 Velocity 模板文件的位置。使用时，皮肤和默认模板、CSS 和图像被禁用。强烈建议您将其打包为皮肤。用户属性是：`templateFile`。
xdoc目录	`文件`	`-`	已弃用。使用标准 m2 目录布局默认值为：`${basedir}/xdocs`。

参数详情

属性：

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

类型：java.util.Map
要求：否

生成项目信息：

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

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

生成站点目录：

包含生成文档的目录。这用于获取可能在构建时生成的其他源文档。

类型：java.io.File
要求：否
默认：${project.build.directory}/generated-site

输入编码：

指定输入编码。

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

语言环境：

Maven 支持的以逗号分隔的语言环境列表。第一个有效令牌将是此 Java 虚拟机实例的默认语言环境。

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

maven会话：

当前的 Maven 会话。

类型：org.apache.maven.execution.MavenSession
要求：否
默认值：${会话}

模块排除：

模块类型排除映射例如：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>