Asciidoctor 是使用純文字編輯的文檔格式,與 Markdown 用途相近(
用法比較),利用特定的標記可以呈現為HTML、PDF等其他格式,可以根據排版的需求搭配css或模板進行輸出。上一篇「
ubuntu18 + python2 文件編輯 AsciiDoc 安裝說明」提到的 AsciDoc 的進化版,AsciDoc 已經停止更新,目前 Asciidoctor 更活耀,常用在電子書或Git專案文件的撰寫。[
使用手冊]
安裝
安裝 Asciidoctor(作業系統 Ubuntu 18)
sudo apt-get install -y asciidoctor
完成後可以確認安裝版本
asciidoctor --version
asciidoctor -V
簡易範例
1. 建立檔案
新增一個檔案
sample.adoc,內容:
.Sample document
====
Here's a sample AsciiDoc document:
[listing]
....
= Title of Document
Doc Writer
:toc:
This guide provides...
....
The document header is useful, but not required.
====
2. 輸出 html
asciidoctor sample.adoc
在同一個目錄下會產生同檔名的HTML檔案
sample.html
預設情況都是轉成html5,並搭配css3,如果想要轉成其他格式,可以加上
-b(
--backend) 來指定:
// for *.xml
asciidoctor -b docbook sample.adoc
Custom Theme
預覽剛剛的
sample.html ,發現除了標題、內文等會自動加上顏色或背景,是預設套用的 css3成果:
可利用自訂的 css 來美化頁面,以
asciidoctor-skins 寫好的主題套用作為範例。下載:
git clone https://github.com/darshandsoni/asciidoctor-skins.git
重新輸出時,
-a(
--attribute) 加上 css 的路徑:
asciidoctor -a stylesheet=./asciidoctor-skins/css/notebook.css sample.adoc
// or
asciidoctor -a stylesheet=notebook.css -a stylesdir=./asciidoctor-skins/css sample.adoc
開啟畫面會套用新的 stylesheet,如下:
常用參數
除了上面提到的
-a 和
-b ,其他常見的選項:
1. 輸出檔名 -o
// -o, --out-file
asciidoctor sample.adoc -o mypage.html
2. 輸出路徑 -D
// -D, --destination-dir
asciidoctor sample.adoc -D pages
輸出檔案會在資料夾
/pages 內。
3. 僅輸出內容 -s
// -s, --no-header-footer
asciidoctor sample.adoc -o mypage.html
只會輸出html中 <body> 標籤裡的內容,方便用於嵌入式頁面。
更多參數可參考:
https://asciidoctor.org/docs/user-manual/#document-conversion