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

Question

我目前正在开发一个用Java编写的项目,我正在使用Maven和maven-site-plugin生成一个包含所有相关JavaDoc,报告等的网站.我需要同时能够转换它将文档转换成可读的书本格式.是否有任何脚本或工具设计用于访问网站,并将其转换为格式合理的PDF或其他样式,以便可以轻松地以数字形式或打印出来？

Answer 1

在Maven的PDF格式的插件生成的项目文档的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使用命令行激活配置文件,或者如果想要更细粒度,可以使用激活配置.