美文网首页
Markdown在项目中的实践

Markdown在项目中的实践

作者: chaul | 来源:发表于2017-11-02 17:41 被阅读0次

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

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

第一步配置好Svn库:


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


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


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

相关文章

  • Markdown在项目中的实践

    在Markdown之前,我们使用Word编辑项目文档,基本上只能一个人编辑文档,而且如果用多台机器也不太方便,一不...

  • Markdown在项目中的实践

    在Markdown之前,我们使用Word编辑项目文档,基本上只能一个人编辑文档,而且如果用多台机器也不太方便,一不...

  • 三分钟学会常用MarkDown语法

    一、实践效果 MarkDown MarkDown MarkDown MarkDown MarkDown MarkD...

  • markdown文件生成目录的方式

    markdown语法简单好上手,在项目中很多文档都是采用markdown语法完成的,以下介绍两种在markdown...

  • markdown在项目中的使用

    前瞻 本文档主要介绍editor.md的使用,editor.md是国内开发的开源项目,可以实现markdown编辑...

  • markdown在oc项目中的应用

    Markdown 是一种轻量级标记语言,它允许人们使用易读易写的纯文本格式编写文档,然后转换成格式丰富的HTML页...

  • Retrofit2.0项目中实践

    前言 项目中开始使用retrofit2.0作为网络框架,注解的形式使用起来确实简洁。2.0版本相比之前有了比较大的...

  • Git在项目中的实践

    Git 的基础命令可以参考下面的链接,写的浅显易懂而且全面http://www.liaoxuefeng.com/w...

  • BLUEPILL在项目中的实践

    Xcode工程项目结构体系; 如何获取上面提到的两个文件并使用上面这个最简单命令跑起来(是否包含了Test,如果没...

  • nextTick在项目中的实践

    前端 | nextTick在项目中的实践.png 前言 在项目中经常需要在视图层立即显示数据,而有时候由于异步数据...

网友评论

      本文标题:Markdown在项目中的实践

      本文链接:https://www.haomeiwen.com/subject/khrapxtx.html