使用 Markdown 编辑器来写 Confluence 文档
使用 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 文件点击插入即可。