使用 Markdown 編輯器來寫 Confluence 文檔
作為一種輕量級標記語言,Markdown 優點多,包括但不限於:
- 純文本,兼容性極強,可以用所有文本編輯器打開
- 讓寫作者專注於文字而不是排版
- 格式轉換方便,Markdown 的文本可以輕松轉換為 html、電子書
- Markdown 的標記語法有極好的可讀性
概括來講,Markdown 易懂易寫,但 Confluence 沒有提供支持 Markdown 格式的編輯器,這對習慣於寫 Markdown 文檔的開發者來說是一件很苦惱的事情。但好在這個問題存在一個曲折的解決方法,即是先將 markdown 文檔轉成 wiki 文檔,再通過 Confluence 的 wiki 導入功能插入文檔內容。
Markdown -> wiki -> Confluence
markdown -> wiki
Github 上有一個 mardown 項目,可將 markdown 文檔轉成 wiki 文檔,使用方法有兩種:
通過 npm i markdown2confluence -g 安裝在本地,再通過命令 markdown2confluence doc.md 進行轉換
在線轉換 http://chunpu.github.io/markdown2confluence/browser/
將 markdown 文檔復制粘貼到輸入區即可生成對應的 wiki 文檔
wiki -> Confluence
在 Confluence 界面選擇 +
號 選擇插入 wiki 標記
復制上一步得到的 wiki 文件點擊插入即可。