ICode9

精准搜索请尝试: 精确搜索
首页 > 其他分享> 文章详细

Asciidoctor-pdf生成pdf文件

2021-04-13 02:02:02  阅读:301  来源: 互联网

标签:Asciidoctor default adoc 生成 theme asciidoctor pdf yml


本文由asciidoctor转docbook,再由pandoc转markdown而来

简述

asciidoctor-pdf是Asciidoctor一个使用Prawn将asciidoc文档转换成pdf的插件,由Asciidoctor组织开发维护,托管在GitHub上,本文将简单介绍下这个插件的使用,部分内容来源于官方。

安装

使用gem安装

$ gem install asciidoctor-pdf

语法高亮支持

Rouge (preferred, minimum version: 2.0.0)

$ gem install rouge

Pygments

$ gem install pygments.rb

CodeRay

$ gem install coderay

启用语法高亮,只需要在.adoc文档头部填写如下内容即可:

:source-highlighter: rouge

使用

基本命令,转换asciidoc成为pdf

$ asciidoctor-pdf basic-example.adoc
$ # 这两个命令是等效的,只不过上边的命令更加简洁
$ asciidoctor -r asciidoctor-pdf -b pdf basic-example.adoc

这里需要说明一下,如果文档中包含中文,初次转换的时候会出现乱码的问题。解决方式请看中文乱码问题章节。

我是占位符

后续新增内容区间

问题

中文乱码问题

如果文档中包含中文,初次转换的时候会出现乱码的问题。这里简单介绍下asciidoctor-pdf的默认主题。如果查阅了asciidoctor-pdf的帮助文档,就会知道他支持自定义主题的。中文乱码的原因也是由于默认主题中使用了非中文字体导致的,需要添加中文字体。这里有两种解决方式可供选择:

  • 创建项目/用户主题

项目和用户的创建方式一样,不同的是二者存储的位置不一样,用户的存储在一个固定文件夹,比如~/.config/adoc,只要使用命令生成的时候填写了正确的路径即可。

  • 在adoc所在文件下新建 fonts文件夹,将中文字体复制到 fonts文件夹中

  • 复制asciidoctor-pdf安装目录中的data/themes/default-theme.yml到当前目录,或者新建一个 theme.yml

  • 编辑修改default-theme.yml内容,主要节点:

font:
  catalog:
    song: # 宋体,请保证fonts文件中包含如下字体
      normal: STSONG.TTF
      bold: STSONG.TTF
      italic: STSONG.TTF
      bold_italic: STSONG.TTF
  base:
    # 设置字体
    font_family: song
literal:
  font_family: song
  • 生成pdf
$ asciidoctor-pdf -a pdf-style=default-theme.yml -a pdf-fontsdir=fonts test.adoc
  • 默认主题

查看../bin/asciidoctor-pdf源码,看到他实际使用的是../../lib/asciidoctor/pdf.rb,我们再查看下这个ruby文件,发现这个又重新定位到../asciidoctor-pdf文件夹,即../lib/asciidoctor-pdf,其中包含了 theme_loader.rb,继续查看这个文件,阅读源码之后,发现默认会先加载主题data\themes\base-theme.yml,如果这个不存在会加载data\themes\default-theme.yml,也就是说base-theme.yml的优先级比default-theme.yml高,我们需要更改base-theme.yml内容。主要修改内容同创建项目/用户主题 章节是一样的。修改完成之后,此后只需要执行:

$ asciidoctor-pdf test.adoc

或者我们可以修改default-theme.yml,或者创建自己的主题文件,此后生成需要指明主题文件:

$ asciidoctor-pdf -a pdf-style=default-theme.yml test.adoc

如果以上两种解决方法不合你心意,那你可以参考下asciidoctor-pdf-cjk-kai_gen_gothic这个项目,这是一个asciidoc-pdf的主题项目,主要用于支持CJK [1],支持中文简体、繁体、韩语、日语等。

[1] 中日韩统一表意文字(CJK Unified Ideographs)

标签:Asciidoctor,default,adoc,生成,theme,asciidoctor,pdf,yml
来源: https://www.cnblogs.com/pinnsvin/p/14651339.html

本站声明: 1. iCode9 技术分享网(下文简称本站)提供的所有内容,仅供技术学习、探讨和分享;
2. 关于本站的所有留言、评论、转载及引用,纯属内容发起人的个人观点,与本站观点和立场无关;
3. 关于本站的所有言论和文字,纯属内容发起人的个人观点,与本站观点和立场无关;
4. 本站文章均是网友提供,不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属;如您发现该文章侵犯了您的权益,可联系我们第一时间进行删除;
5. 本站为非盈利性的个人网站,所有内容不会用来进行牟利,也不会利用任何形式的广告来间接获益,纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

专注分享技术,共同学习,共同进步。侵权联系[81616952@qq.com]

Copyright (C)ICode9.com, All Rights Reserved.

ICode9版权所有