我想使用spring-asciidoctor-backends构建一个具有Spring外观的文档。我将推荐的Maven插件添加到pom
中,如下所示:
<plugin>
<groupId>org.asciidoctor</groupId>
<artifactId>asciidoctor-maven-plugin</artifactId>
<version>2.1.0</version>
<executions>
<execution>
<id>generate-html-documentation</id>
<phase>prepare-package</phase>
<goals>
<goal>process-asciidoc</goal>
</goals>
<configuration>
<backend>spring-html</backend>
</configuration>
</execution>
</executions>
<dependencies>
<dependency>
<groupId>io.spring.asciidoctor.backends</groupId>
<artifactId>spring-asciidoctor-backends</artifactId>
<version>0.0.6</version>
</dependency>
</dependencies>
</plugin>
然后我使用以下maven命令构建文档:
mvn asciidoctor:process-asciidoc
构建运行,HTML正在生成。不幸的是,结果不是Spring风格的HTML,而是通常的标准Asciidoc风格。
由于没有任何关于如何集成/config/build spring-asciidoctor-backends的分步信息,我现在被卡住了。我认为添加Maven依赖项就足够了。我需要添加一些神奇的配置文件或其他东西吗?
1条答案
按热度按时间nbysray51#
好吧,我做到了。我不得不阅读有关Maven插件、目标和阶段的内容。最后我发现,下面的指令将产生预期的结果:
最后,我想说,不幸的是,我不断遇到代码和指令片段,它们只是假设用户与编写指令的人处于相同的知识水平。然而,情况很少如此。
在文档中包含这一简单的说明有什么害处呢?一个从未在更深层次上处理过Maven插件的人怎么会知道这一点呢?为了创建一个Hello World示例,必须先学习所有的编译器标志是没有帮助的。应该总是有一个可以快速实现的完整的现成解决方案,以便这个主题的新手可以推断出一件事或另一件事。如果有必要的话,其他的事情都会在后面。