AsciiDoc

2017-02-27

  这个工具和 markdown相比,就要重量级的多了,它是一般用来生成互联网上传播的资料的书写的,写出的文档可以被翻译为HTML, PDF, EPUB, man page等,这种资料一般不需要如教科书那般严格的纸质显示效果,所以,和Tex比起来,控制能力可能稍弱,多采用正则的语法,语言表述能力也弱。但是,并不妨碍它成为一个优秀的文档工具。Vulkan Spec,Spring等在使用它。如果说达不到这种级别的项目,用简单的MarkDown或者Word写就可以了。这个东西毕竟是麻烦。相当于学习一门新的语言诶。这个东西只是一个标准,现在使用较多的实现是ruby写的,我在尝试装好这个软件时,花费了不少功夫。我一直不喜欢ruby这个语言和相关的技术栈,几次尝试均让我觉得:怎么不按套路出牌呢?

_some text_  表示斜体
word:   表示对word加粗 
[[some chapter name]]  变量 ,其他位置使用这个变量。如在HTML页面内对应着一个id,就能够做到跳转。

=        表示一级目录
==      二级目录
===   三级目录,以此类推,但是,相信也没有多的层级了。

* 表示列表,用实心圆点起头
** 表示二级列表,用小圆圈起头

<<variable , showing text>>,这是使用变量,在对应的HTML内生成一个超链接
sname:showingText  ftext:vkCreate*    这里是表示重点
flink:targetId     也生成一个超链接,超链接的文本就是targetId,一般用来链接到一个术语(如函数,数据类型等)。
 

include::a.txt   表示文件包含命令

// 表示注释

basetype::someType 
·some underline· 需要加深背景颜色的文字。

总结一下:我觉得这个东西没有必要学,有时间,真还不如学LaTex去,配合着好的可视化前端,没准更让人省心一下。

  1. http://asciidoctor.org/
  2. http://asciidoc.org/
  3. http://www.methods.co.nz/asciidoc/
如果有任何意见,欢迎留言讨论。


[ 主页 ]
COMMENTS
POST A COMMENT

(optional)



(optional)