站点:附加描述符

全名

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

说明

将站点描述符 ( site.xml ) 添加到要安装/部署的文件列表中。

对于 Maven-2.x,仅当项目具有pom打包时才默认启用,因为它将被继承的模块使用,但如果需要,可以为其他项目打包启用。

此默认执行已从pom项目的 Maven 3.x 的内置生命周期中删除。实际使用这些项目为子模块提供公共站点描述符的用户将需要明确定义此目标执行以恢复预期行为。

属性

  • 需要执行一个 Maven 项目。
  • 自版本:2.0
  • 默认绑定到生命周期阶段

可选参数

姓名 类型 自从 描述
<语言环境> 细绳 2.3 要呈现的以逗号分隔的语言环境列表。第一个有效令牌将是该站点的默认语言环境。
默认值为en
用户属性是locales
<pomPackagingOnly> 布尔值 3.0 仅当包装是 pom 时才附加站点描述符。
默认值为true
<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

<pomPackagingOnly>

仅当包装是 pom 时才附加站点描述符。
  • 类型布尔值
  • : 3.0
  • 要求
  • 默认值

<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
  • 默认值