使用Asciidoc代替Markdown和Word撰寫開發文檔

開發文檔通常都由Word或Markdown(格式)撰寫,前則多見於企業項目,後則在開源界很流行。但在實際使用中總以爲不盡人意。html

他們的不是

Word的問題git

  1. 表現上:格式過於複雜,致使寫出來的文檔排版、格式很不統一,千人千面,不利於標準化
  2. 工具上:要麼收費(MS)要麼廣告多(WPS)要麼不穩定(一些開源的Office),另外這些都是很重工具
  3. 不被開源界待見,你說你寫了個開源工具,文檔是word的,很不和諧呀……:confused:

Markdown的問題github

  1. 表現上:絕對是矯枉過正了,它的語法太簡單了,用MD寫一篇文章(如本文)還湊合,但要寫一個文檔的話束縛太多了,誰用誰知道
  2. 工具上:Gitbook不錯,將MD文檔用GIT託管是個很不錯的Idea,不過它的新版本把導出功能給閹割了(須要用命令行處理),不厚道,有點被gitbook平臺綁架的感受

說了這兩個東西不是,那麼天然會引薦更合適的嘍,這就是咱們主角 Asciidoc :heart:工具

你的好

Asciidoc有什麼魅力呢?學習

  1. 簡潔而不簡陋的語法,它專門爲編寫書籍而生,在語法的支持上很到位,但不像Word那樣能夠隨性,能夠讓你的文檔更統一美觀
  2. AsciidocFX工具開源跨平臺,使用體驗很不錯,更能夠導出HTML、PDF、EBook等格式
  3. Gitbook也支持這個語法(若是你但願用它的話)

一圖勝千言ui

AsciidocFX效果

如何學習Asciidoc?

  1. 瞭解語法 http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/
  2. 有個中語版的語法介紹 http://houqp.github.io/wbwa/wbwa.html
  3. 有更好的示例嗎?固然有嘍,用AsciidocFX能夠方便地建書籍示例: 新建示例書籍

它生成的HTML以下:命令行

代碼和表格示例

不要懷疑,這些圖及公式是Asciidoc語法生成的圖片!htm

繪圖及公式

Enjoy!

相關文章
相關標籤/搜索