【文檔插件】使用intellij IDEA AsciiDoc插件查看SpringCloud alibaba 開發文檔

背景

我們開發過程中,查看SpringCloud alibaba開源代碼文檔中出現了.adoc文件,爲了瞭解並使用這個文件,簡單記錄以下功能和用法,方便後續查閱使用.

adoc 文檔編輯利器

asciiddoc功能比較強大,比markdown給爲強大,但是也複雜一下,使用門檻稍高,但不過還好。查查手冊經常謝謝,很容易掌握的。

markdown 大家基本都熟悉,作爲程序員,進行知識管理,用markdown 有點很多。例如我就喜歡他語法簡潔,在積累下來的大量文檔中搜索變的比較容易。比word要強多了。

markdown和asciidoc的比較

https://asciidoctor.org/docs/asciidoc-vs-markdown/

上邊鏈接有個表格,詳細的比較了兩個的差別。不得不說asciidoc確實有其優點,缺點是語法更加複雜一些了,學習成功更爲加的高了一點。

怎麼開始寫adoc

和寫markdown的方法一樣,只要用一個文本文件就可以,寫好保存爲擴展名爲adoc的文件即可。瀏覽方式在chrome瀏覽器上安裝個插件,就可以實時瀏覽adoc文檔的效果了。

在哪查adoc的語法?

https://asciidoctor.org/docs/#the-basics

如上鍊接中可以找到詳細的手冊,寫的非常的詳細,用哪查哪就行了。除了手冊還有其他的一些知識,例如 一些工具等等的。 基本的寫法和markdown的思路非常類似。

asciidoc的預覽

如何安裝google瀏覽器的asciidoc插件?

  • 到網址 https://asciidoctor.org/docs/editing-asciidoc-with-live-preview/ 下載瀏覽器插件。
  • 把插件asciidoctor-chrome-extension.nex 下載下來。
  • 把擴展名改爲rar,再解壓到目錄中。
  • 用chrome打開 chrome://extensions
  • 點擊加載已解壓的擴展包 按鈕,選擇上邊解壓出來的文件目錄即可。

使用AsciiDoc 插件 for IntelliJ platform 可以預覽

在IDEA中安裝AsciiDoc 後,打開adoc 文件,右則即可以同步預覽;如下圖所示:
在這裏插入圖片描述

使用vscode可以預覽

使用比較簡單,只要安裝vscode,再在vscode裏安一個能預覽asciidoc的插件,打開asciidoc文檔,再點preview就可以了。

使用AsciidocFX

這款軟件是專用於編輯asciidoc文檔,可以它來寫文檔,也可以用它把文檔轉換爲其它的格式,例如pdf,html等等。

adoc 每個文檔頭初始的例子

:sectnums:    //顯示每章的章節
//:toc: macro
:toc: left
:source-highlighter: pygments
:pygments-linenums-mode: inline
:sectnumlevels: 5
:toclevels: 5
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章