adoc 语法

相信作为程序员的各位一定听说过，【程序员是不用 Word 的】

没错，Office 三件套里，PowerPoint 和 Excel 都是程序员除了写代码以外的必备工具和升职加薪必练技能，但是唯独 Word，直接从程序员的电脑里删掉都不会有人发现的。

是因为我们不写文章吗？相反，程序员可能是最需要写文章的群体之一，不论是技术分享还是项目管理，我们总是要写非常多的文字。但是Word有两个最大的缺点，可以说是非常反程序员了：

1.明明是只是展示最基础的文字信息，却需要一个专门的软件来打开一个文本文档。

2.无法用版本管理工具实现同一个文档的版本管理和团队共享

这两点非常的关键。文字信息非常重要且简单，所以我们希望展示文字的时候能够不依赖某个软件。同时文字信息，或者文章，也像代码一样，需要被维护。所以我们不希望这篇文章的载体是一个二进制文件，而应该是一个文本文件。就像我们最熟悉的代码一样。

想要实现这个目标并不难，使用最基础的【.txt】格式的文件就好了。

话虽如此，但最简单的文本格式文件毕竟还是太粗糙了，满足不了我们编写文档的需求。于是就诞生了标记型语言。用文本编写，用编译器或者浏览器展示，既是一个文本文档，也能拥有丰富的文档展示效果。而最为广泛流传的，就是 Markdown 语言了，是【.md】格式的文件。每一个 Github 的Readme 文件都是默认用 Markdown 语言编写的。例如下面这个高赞的 Github 仓库就演示了如何使用 Markdown 语言编写文档。

younghz/Markdown: Markdown 基本语法。(github.com)

Markdown 语言语法简介，即便阅读未经渲染的源文件也有不错的可读性，深受广大程序员的喜爱。但它对于较为复杂的格式例如表格的支持始终遭人诟病，许多网站使用各自不同的扩展语法来实现，也从而导致了各种方言的滋生。尤其是，当你要写的「文章」不是一篇简单的文章，而是一本电子书的时候，Markdown 语言就显得有点不够看了，一方面展示效果很有限，另一方面将他出版为电子书格式也不那么容易，这就诞生了另一个语言。

AsciiDoc。

AsciiDoc 原生支持的特性就足以应付大多数电子文档的编撰需求，你可以使用标准的 AsciiDoc 语法为你的文档添加作者信息、版本信息、表格等特性，它还支持文档引入、自定义块语法等功能。

AsciiDoc 的语法与 Markdown 十分类似，在学会 Markdown 的前提下很容易转向 AsciiDoc 阵营。

在的功能方面，前面已经说过许多功能Markdown要通过扩展语法和HTML来实现，前者直接导致了通用性的缺失，后者提高了后期编撰的成本，而 AsciiDoc 的学习成本也远不及多学一门HTML甚至多种扩展语法。

我最早关注到AsciiDoc，是阅读oreilly的电子书的时候。

大名鼎鼎的oreilly可以说应该贡献了程序员们一半的书单了吧。

就是这个每本技术书籍的封面都是一个动物的出版社。

这个以技术为本的出版社官方推荐的电子书编写语言，就是AsciiDoc。

所以今天简单介绍一下 AsciiDoc 的使用方式，希望能在有一天你需要用到的时候，想起来还有这么个强大而好用的工具。

首先， AsciiDoc 的编写是很简单的，任何一款编译器都能胜任，因为他本质上就是文本文档。而如果你想预览他的展示效果，你需要安装一些插件，例如 VS code 的插件如下。

使用编译器，你可以像下面这样，对后缀为【.asciidoc】或者【.adoc】的文件进行编辑。通过在文本文档中加入语法的方式给文字添加并预览演示效果。

具体的语法可以参照官方文档：

AsciiDoc Language Documentation | Asciidoctor Docs

但是，如果要基于现在文档去生成一份完整的电子书，就需要安装 Asciidoctor 了。

Asciidoctor 是基于 Ruby 编写的，所以你可以使用PyPI进行安装

$ gem **install** asciidoctor

如果你要最终转换成pdf，还需要安装Asciidoctor-pdf

$ gem **install** asciidoctor-pdf

下面是一个非常基础的将example-01.adoc这个文档转换为同名pdf的命令

$ asciidoctor-pdf example-01.adoc

咱们本期就到这里结束啦，我们下期再见~