Markdown 如何转换为 Confluence

Confluence 是一个专业的企业知识管理与协同软件,也可以用于构建企业 wiki。 使用简单,但它强大的编辑和站点管理特征能够帮助团队成员之间共享信息、文档协作、集体讨论,信息推送。Confluence 有自己的一套标记语言,如果想使用 Markdown 的话就需要转换一下。

Markdown 优点

作为一种轻量级标记语言,Markdown 优点包括但不限于:

  • 纯文本,兼容性极强,可以用所有文本编辑器打开
  • 让写作者专注于文字而不是排版
  • 格式转换方便,Markdown 的文本可以轻松转换为 html、电子书
  • Markdown 的标记语法有极好的可读性

概括来讲,Markdown 易懂易写,但 Confluence 没有提供支持 Markdown 格式的编辑器,这对习惯于写 Markdown 文档的开发者来说是一件很苦恼的事情。

Markdown 转 Confluence

通过一个曲折的解决方法,即先将 markdown 文档转成 wiki 文档,再通过 Confluence 的 wiki 导入功能插入文档内容。

Markdown -> wiki -> Confluence

Markdown to Confluence

将 markdown 文档转成 wiki 文档,方法有两种:

  • Github 上有一个 mardown 项目,可将 markdown 文档转成 wiki 文档。通过 npm i markdown2confluence -g 安装在本地,再通过命令 markdown2confluence doc.md 进行转换,也可以通过该项目提供的在线转换进行转换。
  • 使用 Visual Studio Code,安装插件 Markdown to confluence for VSCode Extension,选择相应文件按以下步骤执行:
    • CMD/CTRL + Shift + P -> md2confl: Convert markdown to confluence and Open window
    • Copy text from the window
    • Paste to the Confluence

将 markdown 文档复制粘贴到输入区即可生成对应的 wiki 文档
wiki -> Confluence
WiKi To Confluence

在 Confluence 界面选择 + 号 选择插入 wiki 标记,复制上一步得到的 wiki 文件点击插入即可。

参考链接

  1. 使用 Markdown 编辑器来写 Confluence 文档
  2. markdown2confluence
  3. Markdown to confluence for VSCode Extension
  4. Markdown 教程