V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
zhongshu
V2EX  ›  程序员

Markdown 文档在项目中的实践

  •  
  •   zhongshu · 2017-08-24 10:52:33 +08:00 · 1861 次点击
    这是一个创建于 2633 天前的主题,其中的信息可能已经有所发展或是发生改变。

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

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

    第一步配置好 Svn 库:

    Paste_Image.png

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

    Paste_Image.png

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

    Paste_Image.png

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

    目前尚无回复
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   5247 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 22ms · UTC 05:50 · PVG 13:50 · LAX 21:50 · JFK 00:50
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.