标签

标题

[ 需要靠左边顶格

  1. = 文档标题 (0级) =
  2. == 段落标题 (1级) ==
  3. === 段落标题 (2级) ===
  4. ==== 段落标题 (3级) ====
  5. ===== 段落标题 (4级) =====
  1. .段落,列表,表格或区块标题

](https://github.com/stanzgy/wiki/blob/master/markup/asciidoc-guide.asciidoc#标题)

文字格式

[ 下面的格式标签前后要有空格,没有空格的时候需要是双符号。

强调 强调

\'强调' '强调'

粗体 粗体

+等宽字体+ 等宽字体

等宽字体 等宽字体 里面的格式命令无效

单引号引用'单引号引用'

双引号引用''双引号引用''

无格式文本# 无格式文本 里面的格式命令无效

[字体CSS颜色,背景CSS颜色,文字em大小] 使用在格式前面可以显示颜色和大小可以使用[,,2]的形式

^上标\^ 上标

~下标~ 下标 ](https://github.com/stanzgy/wiki/blob/master/markup/asciidoc-guide.asciidoc#文字格式)

特殊符号

[ (C) © 版权

(TM) ™ 商标

(R) ® 注册商标

— — 破折号

… …​省略号

-> → 右箭头

<- ← 左箭头

=> ⇒ 右双箭头

<= ⇐ 左双箭头

➊ ➊

¶ ¶ ](https://github.com/stanzgy/wiki/blob/master/markup/asciidoc-guide.asciidoc#特殊符号)

文本块样式

[

  1. ////
  2. CommentBlock(注释块)不输出到目标文件
  3. ////
  1. ++++
  2. PassthroughBlock,不转换内部的特殊字符
  3. ++++
  1. ----
  2. ListingBlock(清单块)
  3. 用于计算机的输出和文件列表。也可用于程序代码。里面特殊字符不替换。
  4. ----
  1. ....
  2. LiteralBlock(文字块)
  3. 就像普通文字段落,保留了空格,使用[listing]块标题可以在内部引用其他块样式。
  4. ....
  1. ****
  2. SidebarBlock(侧边栏)
  3. 有边框和背景
  4. ****
  1. ____
  2. QuoteBlock(引用块)
  3. ____
  1. ====
  2. ExampleBlock(例子块)
  3. 会使用数字编号的例子标题[caption="例1: "]
  4. 可以使用NOTE, TIP, IMPORTANT, WARNING, CAUTION标题[NOTE]表示提示块
  5. ====
  1. --
  2. OpenBlock(开放块)
  3. --

](https://github.com/stanzgy/wiki/blob/master/markup/asciidoc-guide.asciidoc#文本块样式)

提示段落

[ 'Tip’提示, 'Note’注意, 'Important’重要, 'Warning’警告 和 'Caution’警示。例子:

  1. NOTE: 这是一个注意的例子。

或使用替代语法:

  1. [NOTE]
  2. 这是一个注意的例子。

|

提示

| 如果警告多于一个段落使用警告段落替代. | ](https://github.com/stanzgy/wiki/blob/master/markup/asciidoc-guide.asciidoc#提示段落)

警告图标和标题

[ |

注意

| 警告可以定制 icons, iconsdir, iconcaption 参数。 |

默认生成文本标题替换图标链接,生成图标链接需要使用-a icons命令行参数。 你可以使用icon参数制定图标的路径。例如:

  1. [icon="./images/icons/wink.png"]
  2. NOTE: What lovely war.

使用 caption 参数定义警告标题下例屏蔽图标并定义了注释警告的标题(在警告图标设置为可用时icons 参数必须设置为icons=None):

  1. [icons=None, caption="特殊提示"]
  2. NOTE: This is my special note.

](https://github.com/stanzgy/wiki/blob/master/markup/asciidoc-guide.asciidoc#警告图标和标题)

列表

无序列表

[

  1. - List item.
  2. * List item.
  3. ** List item.
  4. *** List item.
  5. **** List item.
  6. ***** List item.

](https://github.com/stanzgy/wiki/blob/master/markup/asciidoc-guide.asciidoc#无序列表)

有序列表

[ 手动序号序号使用下面一种

  1. 1\. 阿拉伯数字标注的列表项目.
  2. a. 小写字母标注的列表项目.
  3. F. 大写字母标注的列表项目.
  4. iii) 小写罗马数字标注的列表项目.
  5. IX) 大写罗马数字标注的列表项目.

自动符号列表项目是1-5个句点,跟着是一些空格和文本。句点个数表示级别。例如:

  1. . 阿拉伯数字标注的列表项目.
  2. .. 小写字母标注的列表项目.
  3. ... 小写罗马数字标注的列表项目.
  4. .... 大写字母标注的列表项目.
  5. ..... 大写罗马数字标注的列表项目.

](https://github.com/stanzgy/wiki/blob/master/markup/asciidoc-guide.asciidoc#有序列表)

定义列表

[ 字母或数字开始1-4个冒号或两个分号结束。

  1. 项目1::
  2. 项目2::
  3. 项目说明.
  4. 项目说明.
  5. 项目3:: 项目说明.
  6. * 列表项.
  7. * 列表项.
  8. 项目4::
  9. 说明1.
  10. 二级项目;;
  11. 二级说明.
  12. 二级项目;;
  13. 二级说明.
  14. 二级项目;;
  15. 二级说明.
  16. 三级项目::: 三级说明.
  17. 三级项目::: 三级说明.
  18. *水平项目*:: 水平说明.
  19. 水平说明.

](https://github.com/stanzgy/wiki/blob/master/markup/asciidoc-guide.asciidoc#定义列表)

问答列表

[

  1. [qanda]
  2. 问题1::
  3. 答案1.
  4. 问题2::
  5. 答案2.

](https://github.com/stanzgy/wiki/blob/master/markup/asciidoc-guide.asciidoc#问答列表)

专业术语列表

[

  1. [glossary]
  2. 术语1::
  3. 解释1.
  4. 术语2::
  5. 解释2.

](https://github.com/stanzgy/wiki/blob/master/markup/asciidoc-guide.asciidoc#专业术语列表)

脚注

[

  1. A footnote footnote:[An example footnote.];
  2. a second footnote with a reference ID footnoteref:[note2,Second footnote.];
  3. finally a reference to the second footnote footnoteref:[note2].

](https://github.com/stanzgy/wiki/blob/master/markup/asciidoc-guide.asciidoc#脚注)

超链接

[ 'http','https','ftp','file','mailto’和’callto’超链接。直接书写就行,参数是显示名称,空格使用%20。

  1. http://www.methods.co.nz/asciidoc/[The AsciiDoc home page]
  2. http://www.methods.co.nz/asciidoc/
  3. mailto:joe.bloggs@foobar.com[email Joe Bloggs]
  4. joe.bloggs@foobar.com

](https://github.com/stanzgy/wiki/blob/master/markup/asciidoc-guide.asciidoc#超链接)

锚点

[

  1. 锚点:[[A88]]
  1. 链接:<<A88,chapter titles>>

](https://github.com/stanzgy/wiki/blob/master/markup/asciidoc-guide.asciidoc#锚点)

图片

[

  1. image:images/logo.png["Company Logo",height=32,link="screen.png",scaledwidth="75%"align="left"]

](https://github.com/stanzgy/wiki/blob/master/markup/asciidoc-guide.asciidoc#图片)

表格

[

  1. [width="40%",cols="^,2m",frame="topbot",options="header,footer"]
  2. |======================
  3. |Column 1 |Column 2
  4. |1 |Item 1
  5. |2 |Item 2
  6. |3 |Item 3
  7. |6 |Three items
  8. |======================
  1. 表格参数:
  1. frame边框topbot(上和下),all(全部边,默认), none and sides (左和右)。
  2. align对齐leftrightcenter
  3. options选项header(有标题)footer(有底部)
  4. width宽度1-99%
  1. 行参数:
  1. [<multiplier>*][<align>][<width>][<style>]
  2. 左缩进,对齐,宽度,样式
  1. 单元格参数:
  1. [<span>*|+][<align>][<style>]
  2. *缩进,+合并
  3. span语法[水平][.垂直]参数中<,^和>分别表示水平左中右和垂直上中下。

](https://github.com/stanzgy/wiki/blob/master/markup/asciidoc-guide.asciidoc#表格)