Apache Maven 站点插件

站点插件用于为项目生成站点。生成的站点还包括在 POM 中配置的项目报告。

如果您想从以前的版本升级,请阅读迁移指南。

目标概述

站点插件有七个目标:

  • site:site用于为单个项目生成站点。请注意,多模块构建中的模块站点之间的链接将不起作用,因为本地构建目录结构与部署的站点不匹配。
  • site:deploy用于使用 Wagon 支持的协议将生成的站点部署到 POM 的<distributionManagement>部分中指定的站点 URL。
  • site:run启动站点,根据要求呈现文档以加快编辑速度。它使用 Jetty 作为 Web 服务器。
  • site:stage根据在 POM 的<distributionManagement>部分中指定的站点 URL 在本地暂存或模拟目录中生成站点。它可用于测试多模块构建工作中模块站点之间的链接。此目标要求站点已经使用站点目标生成,例如通过调用mvn site
  • site:stage-deploy将生成的站点部署到 POM 的<distributionManagement>部分中指定的站点 URL 的登台或模拟目录。
  • site:attach-descriptor将站点描述符 ( site.xml ) 添加到要安装/部署的文件列表中。有关站点描述符的更多参考,这里有一个链接
  • site:jar将站点输出捆绑到 JAR 中,以便可以将其部署到存储库。
  • site:effective-site在继承和插值之后计算有效站点描述符。

用法

关于如何使用站点插件的一般说明可以在使用页面上找到。下面给出的示例中描述了一些更具体的用例。

如果您对插件的使用仍有疑问,请查看常见问题解答并随时联系用户邮件列表。邮件列表中的帖子已存档,并且可能已经包含您问题的答案,作为旧线程的一部分。因此,也值得浏览/搜索邮件存档

如果您觉得插件缺少功能或存在缺陷,您可以在我们的问题跟踪器中提交功能请求或错误报告。创建新问题时,请提供您所关注问题的全面描述。特别是对于修复错误,开发人员可以重现您的问题至关重要。出于这个原因,非常感谢整个调试日志、POM,或者最好是附在问题上的小演示项目。当然,补丁也是受欢迎的。贡献者可以从我们的源代码库中查看该项目,并将在帮助使用 Maven 的指南中找到补充信息。