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 文檔。記住,保持文檔簡潔明了,使用有意義的標題和段落,以及適當的列表和表格,可以使文檔更易于閱讀和理解。