Skip to content

diguage/yongle

Repository files navigation

项目模板

友情支持

如果觉得对您有所帮助,看在D瓜哥码这么多字的辛苦上,请友情支持一下,D瓜哥感激不尽,😜

支付宝

微信

有些打赏的朋友希望可以加个好友,欢迎关注D瓜哥的微信公众号,这样就可以通过公众号的回复直接给我发信息。

wx jikerizhi
💡
公众号的微信号是: jikerizhi因为众所周知的原因,有时图片加载不出来。如果图片加载不出来可以直接通过搜索微信号来查找我的公众号。

项目说明

这是一个项目模板,方便基于该项目生成新的项目,复用一些以前积累的比较好的配置。该项目提供的特性如下:

  1. 配置好了 AsciiDoctor 插件,可以自动将 AsciiDoctor 转换成 HTML、Multipages(HTML)、PDF 和 ePub 电子书。

    1. 重点解决了生成 PDF 时的乱码问题;

    2. 解决了生成 PlantUML 图片时,文字挤压的问题;

    3. 解决了 blockdiag 生成图片时,汉字乱码的问题;

  2. 配置好了 GitHub Action 可以自动将文档推送到 GitHub Pages。(可能还需要在 GitHub 上做一下设置。)

  3. 对一些“过期依赖”做了检查,出现则报错中止编译。

将 HTML 转化成 PDF

pom.xml 中已经内置了直接转出 PDF 的处理流程(为了平时的构建速度,默认是注释掉的)。但是,经过对比发现,使用 AsciiDoctor PDF 转出的 PDF,如果将 Asciidoctor Diagram 的图片格式设置为 PNG,那么图片模糊不清,放大以后还是看不清楚;如果设置为 SVG,则图片会多出一些不必要的线框。所以,推荐使用 HTML + wkhtmltopdf。流程如下:

  1. 使用上面“使用方法”中的办法,将文档转化成 HTML,然后启动 HTTP Server,确保可以在浏览器中通过 http://localhost:8888/target/docs/html/index.html 查看到文档内容。

  2. 使用如下命令,将文档转化成 PDF:

    $ wkhtmltopdf --page-size A4 \
                  --header-left "文档标题" \
                  --header-right "`date '+%Y-%m-%d'`·试用版)" \
                  --header-spacing 3 \
                  --header-font-size 10 \
                  --footer-spacing 4 \
                  --footer-left "D瓜哥 · https://www.diguage.com/" \
                  --footer-right '[page] / [toPage]' \
                  --footer-font-size 10 \
                  --margin-top 25mm \
                  --margin-bottom 25mm \
                  --margin-left 20mm \
                  --margin-right 20mm \
                  http://localhost:8888/target/docs/html/index.html 文档标题.pdf

Releases

No releases published

Packages

No packages published