java - 如何在 Maven 插件站点的文档中包含目标和参数

Question

您似乎可以从 Maven 插件项目生成标准文档网站(如 this one)。我尝试在插件项目中执行 mvn site 但它没有生成预期的文档(显示 Mojo 目标、参数等的页面)。是否必须调用其他目标来生成这些网页？我正在使用 Maven v. 2.1.0。

Answer 1

开箱即用，mvn site至少应该生成一个索引页面(并利用项目 POM 中的 name 和 description)和一组基本报告(关于、问题跟踪、项目团队、依赖项、项目插件、持续集成、源代码)存储库、项目许可证、邮件列表、插件管理、项目摘要)。

如果要自定义报告集，可以配置 Maven Project Info Reports Plugin (在 reporting 部分)仅包括您想要的报告:

<project>
  ...
  <reporting>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-project-info-reports-plugin</artifactId>
        <version>2.2</version>
        <reportSets>
          <reportSet>
            <reports>
              <report>dependencies</report>
              <report>project-team</report>
              <report>mailing-list</report>
              <report>cim</report>
              <report>issue-tracking</report>
              <report>license</report>
              <report>scm</report>
            </reports>
          </reportSet>
        </reportSets>
      </plugin>
      ...
    </plugins>
  </reporting>
  ...
</project>

如果您想自定义网站，您需要提供 site descriptor (默认为 src/site/site.xml)。在这种情况下，您必须包含 <menu ref="reports"/>上述报告的条目。

如果你想add content ，您必须使用一种受支持的格式(例如 APT、FML、XDoc)提供它。大多数时间，APT现在使用。

查看 Maven Site Plugin 的文档了解更多详情。