使用 Maven 生成带有 spring rest 文档的 asciidoctor 文档（不是 gradle）

Question

使用 gradle 生成 asciidoctor 文档，您需要在命令行中 gradle asciidoctor 并且此任务生成文档。

使用 Maven，我可以使用 mvn package 生成 asciidoctor 文档。但这打包了所有项目。有没有办法只使用 mvn 来生成文档而不用打包所有项目？

Answer 1

参见 Introduction to the Build Lifecycle。通常在 Maven 中 documentation generation/packaging 绑定到 site 生命周期，这意味着它将在运行 mvn site 时创建。

这是一个 Javadoc 示例，说明如何将插件绑定到 site 阶段：

<build>
  <plugins>
    <plugin>
      <groupId>org.apache.maven.plugins</groupId>
      <artifactId>maven-javadoc-plugin</artifactId>
      <phase>site</phase>
      <goals>
        <goal>jar</goal>
      </goals>
      <configuration>
      ...
      </configuration>
    </plugin>
  </plugins>
</build>

也可以直接使用asciidoctor-maven-plugin:

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-site-plugin</artifactId>
            <version>3.4</version>
            <dependencies>
                <dependency>
                    <groupId>org.asciidoctor</groupId>
                    <artifactId>asciidoctor-maven-plugin</artifactId>
                    <version>{release-version}</version>
                </dependency>
            </dependencies>
        </plugin>
    </plugins>
</build>

（取自asciidoctor documentation）

使用 Maven 生成带有 spring rest 文档的 asciidoctor 文档（不是 gradle）

Generate asciidoctor doc with spring rest docs using maven (not gradle)

spring

gradle

maven

spring-restdocs