Markdown To Confluence Wiki

Markdown To Confluence Wiki

做爲一名程序員，相信你們已經很是熟悉 Markdown 並深深的愛上了她(what? 還不知道，如今瞭解也不遲，相信你也會愛上她)。本文不過多的介紹Markdown，主要介紹如何便捷的將Markdown文檔轉換爲confluence格式。

背景

如今幾乎全部的網站或博客都支持Markdown格式的編輯器。同時，本人寫博文是喜好用Markdown的，可是公司內部用的是Confluence，它內部的我的站點在寫wiki時，沒有Markdown格式的編輯器。每次將寫好的Markdown格式的文章移到內部wiki時，總須要調整格式，這就多了許多沒必要要的人工成本。雖然Confluence也有支持Markdown的宏，可是本人認爲過於醜陋。這就有必要研究下如何能更好地、更便捷的將Markdown格式轉換爲Confluence下的wiki格式。固然，其餘同事也反映了這個問題。接下來向你們介紹如何操做。

Markdown介紹

什麼是Markdown呢，維基百科的定義以下：

Markdown 是一種輕量級標記語言，創始人爲約翰·格魯伯（John Gruber）。它容許人們「使用易讀易寫的純文本格式編寫文檔，而後轉換成有效的XHTML(或者HTML)文檔」。

看到定義中的 易讀易寫 四個字，我以爲這也是程序員所追求的。咱們所作的工做就是讓繁瑣的事情更簡單、更容易。

Markdown如何轉換爲Confluence Wiki

通過了解後，發現有兩種方式能夠將Markdown格式轉換爲Confluence的wiki格式。

使用 Typora 工具

Typora 是一款Markdown編輯工具，能夠直接看到Markdown內容的預覽，推薦你們使用。

對於Markdown格式文章中沒有代碼塊和其餘複雜格式時，能夠直接複製 Typora 中的內容粘貼到Confluence的wiki中，格式是同樣的。

對於有代碼塊等複雜格式的Markdown文檔，可使用下面這種方式。

使用 Github上的 markdown2confluence 工具

經過調研，在Github上發現了一個比較好用的工具: chunpu/markdown2confluence ，通過測試，發現有點小問題，而後給做者提了個PR。如今已經徹底可用。

此工具的思想是：把Markdown格式轉換爲Confluence支持的Wiki markup格式，而後經過插入Wiki標記的方式來實現：

• 先將Markdown格式的文檔粘貼到 http://chunpu.github.io/markdown2confluence/browser/ 作格式轉換。
• 在編輯模式下，點擊 Insert -> Wiki標記，插入類型選擇企業維基，將轉換後的Wiki Markup格式的內容粘貼到左側，在右側會看到預覽的內容，而後點擊插入按鈕便可完成。

寫個Demo吧：

Markdown內容以下：

# 文檔標題

在這裏能夠說一些題外的話，這那的。

## 二級標題1

寫個list吧:

- list1
- list2
- list3

[Markdown](http://wowubuntu.com/markdown/) 語法說明

​```
cd ~
mkdir tmp
echo "just test" > tmp
​```

這是一句話

![Mou icon](http://25.io/mou/Mou_128.png)

經過 markdown2confluence 工具轉換後的wiki markup內容：

h1. 文檔標題

在這裏能夠說一些題外的話，這那的。

h2. 二級標題1

寫個list吧:

- list1
- list2
- list3

[http://wowubuntu.com/markdown/]

{code:language=bash|borderStyle=solid|theme=RDark|linenumbers=true|collapse=false}
cd ~
mkdir tmp
echo "just test" > tmp
{code}

這是一句話

!http://25.io/mou/Mou_128.png!

在Confluence的我的空間建立一個wiki，點擊 加號 -> Wiki標記，將生成的wiki markup的內容粘貼到左側，點擊插入。能夠看到效果：

雖然沒有徹底的自動化，但仍是爲你們節省了很多人力成本。就醬~

相關閱讀

• Markdown 語法說明 
• 讓文檔迴歸本質，爲何應該用Markdown
• Confluence Wiki Markup
• Code Block Macro
• https://github.com/chunpu/markdown2confluence