我想向您介绍从Maven使用AsciiDoc的最简单方式,那就是https://github.com/asciidoctor/asciidoctor-maven-plugin[Asciidoctor Maven 插件]!
组ID | 构件ID | 最新版本 | 下载 |
---|---|---|---|
org.asciidoctor |
这个插件对于有兴趣使用AsciiDoc来撰写文档的项目来说是一个很好的选择,或者对任何使用AsciiDoc的项目部分感兴趣的情况。最重要的是,它已经可以从Maven Central获得。
它是如何工作的
Maven 插件加载 JRuby,扫描指定目录中的 AsciiDoc 文件,然后调用 Asciidoctor 进行渲染。你可以选择将文件渲染成 HTML 5 和 DocBook 4.5。
安装和使用
将这个插件添加到你的Maven POM中非常简单。只需添加这个插件声明:
xml <plugin> <groupId>org.asciidoctor</groupId> <artifactId>asciidoctor-maven-plugin</artifactId> <version>0.1.1</version> <executions> <execution> <id>render-asciidoc</id> <phase>generate-resources</phase> <goals> <goal>process-asciidoc</goal> </goals> </execution> </executions> <configuration> <sourceDirectory>docs</sourceDirectory> <outputDirectory>target/docbook/en-US</outputDirectory> <backend>docbook</backend> </configuration> </plugin>
执行构建时,由Maven来处理执行。
您可以在GitHub上https://github.com/asciidoctor/asciidoctor-maven-plugin[项目存储库]中找到更为详细的设置和使用说明,具体位于https://github.com/asciidoctor/asciidoctor-maven-plugin#readme[README]。
版本控制
Maven插件的版本将跟踪Asciidoctor的版本。在大多数情况下,版本号将与Asciidoctor版本号相匹配(例如,0.1.1)。如果需要对插件进行临时修复,将在Asciidoctor版本号的末尾添加一个额外的数字(例如,0.1.1.1)。
未来
当前,该插件使用自己的JRuby集成来调用Asciidoctor(它是用Ruby编写的)。下一个版本(https://github.com/asciidoctor/asciidoctor-maven-plugin/issues[路线图])将使用新发布的Asciidoctor Java集成来简化过程并简化项目的维护。
与转为内部使用Asciidoctor Java集成的变更相结合,将添加新的配置选项。其中的一个选项将允许你将AsciiDoc属性传递给渲染器。AsciiDoc属性控制诸如添加目录、打开章节编号以及配置源代码高亮显示等选项。
贡献
我们始终对补丁、更好的文档、功能请求、传教或您能提供的任何帮助持开放态度。