Asciidoc 是一种人类可读的文档格式,它可以用简单的文本编辑器编写,然后转换为多种输出格式,如 HTML、PDF、EPUB 等
在 Asciidoc 中,使用一级标题(=
)表示 H1 标题,二级标题(-
)表示 H2 标题,以此类推。使用空行分隔标题和段落。
= H1 Title
This is a paragraph.
使用数字加句点表示有序列表,使用破折号、加号或星号表示无序列表。
1. Ordered list item 1
2. Ordered list item 2
3. Ordered list item 3
- Unordered list item 1
- Unordered list item 2
- Unordered list item 3
使用 [link text](url)
格式插入链接,使用 ![image alt text](image url)
格式插入图片。
[GNU General Public License v3](https://www.gnu.org/licenses/gpl-3.0.en.html)
![Asciidoc logo](https://www.asciidoctor.org/images/logo- asciidoc-600x400.png)
使用三个反引号(```)包裹的文本会被视为代码块,使用单个反引号(`)包裹的文本会被视为行内代码。
This is a code block.
`This is an inline code.`
使用 |
分隔列,使用 -
分隔表头和其他行。
| Header 1 | Header 2 | Header 3 |
|---------|---------|---------|
| Row 1, Cell 1 | Row 1, Cell 2 | Row 1, Cell 3 |
| Row 2, Cell 1 | Row 2, Cell 2 | Row 2, Cell 3 |
Asciidoc 支持使用别名和宏来简化文档编写。例如,定义一个宏 my-macro
:
:my-macro: This is a macro.
然后在文档中使用这个宏:
{{my-macro}}
Asciidoc 支持使用预处理器来扩展其功能。例如,使用 Asciidoctor 预处理器可以将 Asciidoc 文档转换为 HTML:
asciidoctor my-document.adoc
通过这些方法,你可以编写高效的 Asciidoc 文档。记住,保持文档简洁明了,使用有意义的标题和段落,以及适当的列表和表格,可以使文档更易于阅读和理解。