轻松记录您
灵感和创意

Markdown在项目中的实践

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

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

第一步配置好Svn库:

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

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

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

未经允许不得转载:坚果云Markdown编辑器 » Markdown在项目中的实践
分享到: 更多 (0)

坚果云Markdown轻松记录您 灵感和创意

坚果云Markdown下载坚果云Markdown介绍