AsciiDoc Intro

Table of Contents

• 语法
  • 标题
  • 段落
  • 行内格式
  • 引用
  • 超链接
  • 图片
  • 列表
  • 代码块
  • 醒目
  • 表格
• 官方文档

查看在线文档，效果更佳： https://mazhuang.org/asciidoc-intro/README.html

语法

标题

AsciiDoc

= 一级标题
== 二级标题
====== 六级标题

段落

中间没有空行的连续不断的几行文字被视为一个段落。

AsciiDoc

白日依山尽，

黄河入海流。
欲穷千里目，

更上一层楼。

预览效果

白日依山尽，

黄河入海流。 欲穷千里目，

更上一层楼。

行内格式

对段落或部分文本的强调效果。

AsciiDoc

后面俩字加 *粗体*

后面俩字加 _斜体_

预览效果

后面俩字加 粗体

后面俩字加 斜体

引用

AsciiDoc

[quote, mzlogin]
____
这是一段引用。
____

预览效果

这是一段引用。

— mzlogin

超链接

AsciiDoc

https://mazhuang.org[码志]

预览效果

码志

图片

AsciiDoc

image::https://mazhuang.org/assets/images/qrcode.jpg[闷骚的程序员]

列表

AsciiDoc

.无序列表
* level 1
** level 2
*** level 3
* level 1

.有序列表
. level 1
.. level 2
... level 3
. level 1

无序列表

• level 1

  • level 2

    • level 3

• level 1

有序列表

1. level 1

   1. level 2

      1. level 3

2. level 1

代码块

AsciiDoc

[source, java]
----
if (TextUtils.isEmpty(text)) { // (1)
    return null;
}
----
<1> 判断 text 是否为空

预览效果

if (TextUtils.isEmpty(text)) { // (1)
    return null;
}

1. 判断 text 是否为空

醒目

默认不会展示醒目 ICON，需要 :icons: font 开启，支持 NOTE、CAUTION、WARNING、IMPORTANT、TIP。

AsciiDoc

NOTE: 注意

CAUTION: 小心

WARNING: 警惕

IMPORTANT: 重要

TIP: 提示

Note

注意

Caution

小心

Warning

警惕

Important

重要

Tip

提示

表格

AsciiDoc

|===
|表头1|表头2

|content1|content2
|===

Table 1. 预览效果

表头1	表头2
content1	content2

官方文档

• AsciiDoc Syntax Quick Reference

• Asciidoctor User Manual