AsciiDoc

AsciiDoc is a text document format for writing notes, documentation, articles, books, ebooks, slideshows, web pages, man pages and blogs.

AsciiDoc files can be translated to many formats including HTML, PDF, EPUB, man page.

以前一直使用 markdown 进行文本编辑,不过有时候 markdown 对复杂格式(例如表格、图片标题)支持不够,导致有很多分支。

今天无意间看到下面的标记语言,觉得更加健全成熟。

Quick Start

写法

= Hello, AsciiDoc!
Doc Writer <doc@example.com>

An introduction to http://asciidoc.org[AsciiDoc].

== First Section

* item 1
* item 2

[source,ruby]
puts "Hello, World!"

语法:AsciiDoc Syntax Quick Reference

文件后缀:使用 .adoc

特性

AsciiDoc 相比 Markdown 支持更多的格式,包括而不限于:

  • 文档属性,设置作者、版本信息等。

  • 语法高亮。

  • 表格。

  • Include 功能,将大文档拆分几个文件。

  • 自定义块语法,可扩展性。

ATOM

对于轻量级文本,使用任何的记事本即可。不过优秀的编辑器可以使得写作更加愉悦高效。

ATOM is a hackable text editor for the 21st Century.

下载

首页 点击下载即可。

安装

MAC 系统的 atom-mac.zip 解压后是一个 ATOM 运行程序。

如果想可以在应用程序中找到此程序,直接复制到应用程序中即可。

效果图

当前这个版本没有内置支持预览。安装 asciidoc-preview 插件即可。

直接打开 mac terminal 命令行,输入

apm install asciidoc-preview

日志如下:

$ apm install asciidoc-preview
Installing asciidoc-preview to /Users/houbinbin/.atom/packages 
✓

然后重启下编辑器,control+shift+a 可以开启预览。

2017-02-19-atom-asciidoc-preview.png

测试环境

  • MAC 版本
ProductName:	Mac OS X
ProductVersion:	10.13.1
BuildVersion:	17B1003
  • ATOM 版本
Atom    : 1.24.0
Electron: 1.6.16
Chrome  : 56.0.2924.87
Node    : 7.4.0

Markdown editor

Typora

功能拓展

asciidoctor-diagram