博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
Asciidoctor Maven插件使用
阅读量:6202 次
发布时间:2019-06-21

本文共 4395 字,大约阅读时间需要 14 分钟。

在项目应用中,我们会写很多文档去传递我们的设计思想、开发经验、采坑经历等等。使用Asciidoc的格式对非技术人员就不是那么的友好,或者说传递性、通用性与PDF和网页相比就差很多了。在JVM项目中可以使用Maven的插件方式将.adoc文件格式转化为PDF、HTML、EPUB等文件格式。

快速入门

工程结构

|doc-demo|-src|--main|---asciidoc|----.adoc文件|---resources|----images|pom.xml

pom.xml

4.0.0
com.demo
docs
1.1.0-SNAPSHOT
UTF-8
UTF-8
UTF-8
1.8
1.8
1.5.6
1.5.4.1
1.7.26
process-resources
src/main/resources
${project.build.directory}/book
org.asciidoctor
asciidoctor-maven-plugin
1.5.5
output-html
generate-resources
process-asciidoc
html5
prettify
left
font
true
org.jruby
jruby-complete
${jruby.version}
org.asciidoctor
asciidoctorj
${asciidoctorj.version}
org.asciidoctor
asciidoctorj-diagram
${asciidoctorj.diagram.version}
${project.build.directory}/book
book.adoc
./
false
asciidoctor-diagram

执行mvn命令

mvn clean process-asciidoc

生成的HTML可以使用Http Server或者Nginx等服务进行部署,甚至可以使用Jenkins进行自动化部署。

生成PDF

工程结构

|doc-demo|-src|--main|---asciidoc|----data|-----fonts|-----themes|----.adoc文件|---resources|----images|pom.xml

pom.xml

4.0.0
com.tairanchina.csp.dmp
docs
1.1.0-SNAPSHOT
UTF-8
UTF-8
UTF-8
1.8
1.8
1.5.6
1.5.4.1
1.7.26
1.5.0-alpha-zh.16
process-resources
src/main/resources
${project.build.directory}/book
org.asciidoctor
asciidoctor-maven-plugin
1.5.5
output-html
generate-resources
process-asciidoc
html5
prettify
left
font
true
output-pdf
generate-resources
process-asciidoc
pdf
coderay
book
font
-
data/fonts
data/themes
cn
org.jruby
jruby-complete
${jruby.version}
org.asciidoctor
asciidoctorj
${asciidoctorj.version}
org.asciidoctor
asciidoctorj-diagram
${asciidoctorj.diagram.version}
org.asciidoctor
asciidoctorj-pdf
${asciidoctorj.pdf.version}
${project.build.directory}/book
book.adoc
./
false
asciidoctor-diagram

执行mvn命令

mvn clean process-asciidoc
由于PDF格式插件没有安装中文字体,生成的PDF格式上会存在缺失,上方的fonts和themes可以对PDF的生成格式进行自定义,有时候为了方便,可以将其与
asciidoctorj-pdf源码进行合并,手动打一个依赖包,放到自己的私服仓库中。

常见问题

  • 在生成PDF的时候,可能code部分会存在很多空格的问题,一般产生这样的问题不是字体问题,而是编写格式有问题,可以选择将``符号去掉。

参考资料

转载地址:http://duxca.baihongyu.com/

你可能感兴趣的文章
数据库持久连接理解
查看>>
Android进阶:打jar包获取assets中的资源 解决selector XML文件不能解析的问题
查看>>
[转载]SharePoint 2013搜索学习笔记之自定义结果源
查看>>
上传文件
查看>>
python manage.py startapp app 时候报错No module named _sqlite3
查看>>
11.02 跳过表中n行
查看>>
360遭下架,苹果商店封杀360手机应用
查看>>
2、AD工程创建步骤
查看>>
OO第三次博客作业
查看>>
[转]手把手教你做iOS推送
查看>>
Java公众号推荐 - BeJavaGod
查看>>
iptables规则组成
查看>>
面向对象
查看>>
NEFU OJ 205 最小树(一)
查看>>
hdu 新生晚会
查看>>
python socket网络编程
查看>>
java @override 报错处理
查看>>
docker数据管理--数据卷的备份
查看>>
selenium弹出框的处理
查看>>
hyperledger中文文档学习-1-词汇表
查看>>