一个适合程序员的 Markdown 文档编辑和文档管理方案

我是一个重度的 Markdown 用户。长时间使用过 Day One 、 Ulysses 、 MacDown ，如你所料，最终都放弃了。

坦率讲，Day One 和 U lysses 是你一打开就会觉得非常惊艳的产品，设计上侧重写作者的主观感受和体验，在细节的打磨上非常到位。但是 Day One 的代码质量实在一般，很多闪退 bug 经常把你的写作热情消灭得荡然无存，且没有一个像样的文档管理功能。Ulysses 虽然有文档管理功能，UI 更加惊艳，尤其是沉浸模式非常吸引人，让你觉得在使用艺术品写作，当然，也会让你产生使用它写作能够提高写作质量的错觉:joy: 不过，Ulysses 的文档管理和编辑设定更偏向于普通小白用户。这个本身是没有问题的，因为它的定位是让你享受写作，尽可能少的减少其他方面对用户的打扰。显然，作为一个经常需要从源代码级别去修改文档的用户来说，它的这种好意被我当成了一种功能的羸弱。

在很长一段时间内都没有找到满意的 Markdown 软件。于是，索性用回了只有简单编辑功能的 MacDown，同时也在摸索和完善适合自己使用习惯的 Markdown 文档管理和编辑方案。我理想中的 Makrdown 文档管理方案是这样的：

1. 源代码级的 Markdown 文档编辑能力；不看重所见即所得的功能，且不能接受只提供所见即所得的编辑能力；
2. 符合开发人员习惯的文档管理能力，像管理源代码一样管理我的 Markdown 文档，随时查找、编辑。
3. 如果能够支持文档历史版本管理就更棒了。
4. 成本不要太高，最好是免费的。

不卖关子，先说当前自己用下来比较舒服的方案： Visual Studio Code + Markdown Shortcuts + markdownlint + Bitbucket , 满足自己以上的所有需求，且成本为 0 .

选择 Visual Studio Code 作为编辑器是因为可以把自己写代码的那套文件查找和管理习惯继承过来，并且不需要重新学习和熟悉快捷键。 VS Code 本身支持 Markdown 文档编辑和预览，遗憾的是它的这两个功能都不强大，达不到自己快糙猛的要求。预览功能自己并不看重，因此选择性安装了两个插件( Markdown Shortcuts + markdownlint )来增强其编辑功能。

Markdown Shortcuts 提供了很多编辑 Makrdown 文档的风骚快捷键。我自己常用的有：

• 快速转换成列表：

• excel 表数据转表格：

其他命令如下：

Name | Description | Default key binding

—–|————-|——————–

md-shortcut.showCommandPalette | Display all commands | ctrl+M ctrl+M

md-shortcut.toggleBold | Make bold | ctrl+B

md-shortcut.toggleItalic | Make italic | ctrl+I

md-shortcut.toggleStrikethrough | Make ~~strikethrough~~ |

md-shortcut.toggleLink | Makea hyperlink | ctrl+L

md-shortcut.toggleImage | Make an image

| ctrl+shift+L

md-shortcut.toggleCodeBlock | Make a code block | ctrl+M ctrl+C

md-shortcut.toggleInlineCode | Make inline code | ctrl+M ctrl+I

md-shortcut.toggleBullets | Make * bullet point | ctrl+M ctrl+B

md-shortcut.toggleNumbers | Make 1. numbered list | ctrl+M ctrl+1

md-shortcut.toggleCheckboxes | Make – [ ] check list (Github flavored markdown) | ctrl+M ctrl+X

md-shortcut.toggleTitleH1 | Toggle # H1 title |

md-shortcut.toggleTitleH2 | Toggle ## H2 title |

md-shortcut.toggleTitleH3 | Toggle ### H3 title |

md-shortcut.toggleTitleH4 | Toggle #### H4 title |

md-shortcut.toggleTitleH5 | Toggle ##### H5 title |

md-shortcut.toggleTitleH6 | Toggle ###### H6 title |

md-shortcut.addTable | Add Tabular values |

md-shortcut.addTableWithHeader | Add Tabular values with header |

markdownlint 则是一个语法检查 lint 工具。虽然 Markdown 语法很简单，但是因为经常编辑源代码和插入 html 代码，有一个 lint 还是能够辅助你提前发现很多 typos.

Bitbucket 则是用 git 来做文档的历史版本管理，免费，且支持私有仓库。如此一来，基本上编辑 Makrdown 与编写项目代码的有了相同的使用体验。

小结

习惯这东西本身就是个性化化的东西，并且一旦适应了就很难改变。以上方案只是一个我自己比较舒服的使用习惯。这个方案并不完美，比如它并没有考虑 Markdown 重度图片用户插图的效率问题。另一方面，Evernote 大陆版发布的新版本已经开始支持 Markdown 文档功能（国际版不支持哟）。如果，你是印象笔记的铁粉，不妨一试。

–EOF–