将 Maven 站点软件文档转换为 PDF

Question

我目前正在处理一个用 Java 编写的项目，我正在使用 Maven 和 maven-site-plugin 生成一个包含所有相关 JavaDoc、报告等的网站。我需要同时能够将相同的文档转换为可读的书本格式。是否有任何脚本或工具旨在获取网站，并将其转换为格式合理的 PDF 或其他样式，以便可以轻松地以数字方式提供或打印出来？

Answer 1

maven-pdf-plugin 生成项目文档的 PDF。

需要考虑的文档中的两个注意事项：

注意 1： 默认情况下，PDF 插件会生成一个 PDF 文档，其中汇总了您的所有站点文档。如果要单独生成每个站点文档，需要在命令行中添加-Daggregate=false。

注意 2： 默认情况下，PDF 插件使用 FOP 实现。该插件还支持iText实现，只需要在命令行中添加-Dimplementation=itext即可。

您实际上可以在 POM 中指定聚合属性（参见下面的示例）。

此配置将在 docs 配置文件处于活动状态的每个构建上生成 PDF（您可以在每个构建上都执行此操作，但对于您的典型开发周期来说会有点慢：

<profiles>
  <profile>
    <id>docs</id>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-pdf-plugin</artifactId>
      <version>1.0</version>
      <executions>
        <execution>
          <id>pdf</id>
          <phase>site</phase>
          <goals>
            <goal>pdf</goal>
          </goals>
          <configuration>
            <outputDirectory>
              ${project.reporting.outputDirectory}
            </outputDirectory>
            <aggregate>false</aggregate>
          </configuration>
        </execution>
      </executions>
    </plugin>
  </profile>
</profiles>

您可以在命令行上使用-P docs 激活配置文件，或者如果您想更细粒度地使用activation 配置。