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