Markdown 文档在项目中的实践

[zhongshu]

在 Markdown 之前，我们使用 Word 编辑项目文档，基本上只能一个人编辑文档，而且如果用多台机器也不太方便，一不小心忘记更新就会导致无法合并。Mardown 无需多言，因为纯文本格式，非常适合多人编辑文档，我们在项目中推广 Markdown，把 Markdown 文档放在 Svn 中，这样完美的解决了文档的持续更新问题，不管是多人还是多台机器编辑，都和编辑普通代码没什么区别了，文本的合并使用很成熟的方法即可。

随之而来的问题（或者说不便）是如果要看 Svn 中的 Mardown 文档，需要更新本地目录，并使用专门的软件，这有些不便。程序员还好，其他项目参与人员就更麻烦一些，但我们又不想损失 SVN 管理的优点，所幸我们在Topo 项目管理软件中看到了好的解决方案。

第一步配置好 Svn 库：

然后在项目下，配置项目的代码库目录，可能是一个分支，也可以是一个目录：

这样就可以浏览 Svn 中的 Markdown 文件了，很棒的地方在于，Mardown 中引用的 Svn 里的图片可以正确的显示出来，这样就非常方便了：

通过这种方式，我们把大部分项目文档转到了 Markdown 格式，方便项目成员随时修改和浏览。