站点:有效站点

全名

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

说明

在site.xml的继承和插值之后,对于第一个语言环境,将有效的站点描述符显示为此构建的 XML 。

属性

  • 需要执行一个 Maven 项目。
  • 仅作为报告集(报告目标)执行。
  • 自版本:2.2

可选参数

姓名 类型 自从 描述
<语言环境> 细绳 2.3 要呈现的以逗号分隔的语言环境列表。第一个有效令牌将是该站点的默认语言环境。
默认值为en
用户属性是locales
<输出> 文件 2.2 可选参数,用于将此帮助的输出写入给定文件,而不是写入控制台。

注意:可能是相对路径。


用户属性是输出
<relativizeDecorationLinks> 布尔值 2.3 在站点描述符中创建相对于项目 URL 的链接。默认情况下,出现在站点描述符中的任何绝对链接,例如横幅 href、面包屑、菜单链接等,都将相对于 project.url。如果设置为 false,或者项目没有定义 URL,则不会更改链接。
默认值为true
用户属性是relativizeDecorationLinks
<站点目录> 文件 2.3 包含site.xml文件和手写文档源的目录(每个 Doxia 源支持的标记类型一个目录):请参阅Doxia 标记语言参考)。
默认值为${basedir}/src/site
<跳过> 布尔值 3.0 将此设置为“true”以跳过站点生成和登台。
默认值为false
用户属性是maven.site.skip

参数详情

<语言环境>

要呈现的以逗号分隔的语言环境列表。第一个有效令牌将是该站点的默认语言环境。
  • 类型java.lang.String
  • : 2.3
  • 要求
  • 用户属性语言环境
  • 默认值en

<输出>

可选参数,用于将此帮助的输出写入给定文件,而不是写入控制台。

注意:可能是相对路径。

  • 类型java.io.File
  • : 2.2
  • 要求
  • 用户属性输出

<relativizeDecorationLinks>

在站点描述符中创建相对于项目 URL 的链接。默认情况下,出现在站点描述符中的任何绝对链接,例如横幅 href、面包屑、菜单链接等,都将相对于 project.url。如果设置为 false,或者项目没有定义 URL,则不会更改链接。
  • 类型布尔值
  • : 2.3
  • 要求
  • 用户属性relativizeDecorationLinks
  • 默认值

<站点目录>

包含site.xml文件和手写文档源的目录(每个 Doxia 源支持的标记类型一个目录):请参阅Doxia 标记语言参考)。
  • 类型java.io.File
  • : 2.3
  • 要求
  • 默认${basedir}/src/site

<跳过>

将此设置为“true”以跳过站点生成和登台。
  • 类型布尔值
  • : 3.0
  • 要求
  • 用户属性maven.site.skip
  • 默认值