Markdown在項目中的實踐

在Markdown之前,我們使用Word編輯項目文檔,基本上只能一個人編輯文檔,而且如果用多臺機(jī)器也不太方便,一不小心忘記更新就會導(dǎo)致無法合并。Mardown無需多言,因為純文本格式,非常適合多人編輯文檔,我們在項目中推廣Markdown,把Markdown文檔放在Svn中,這樣完美的解決了文檔的持續(xù)更新問題,不管是多人還是多臺機(jī)器編輯,都和編輯普通代碼沒什么區(qū)別了,文本的合并使用很成熟的方法即可。

隨之而來的問題(或者說不便)是如果要看Svn中的Mardown文檔,需要更新本地目錄,并使用專門的軟件,這有些不便。程序員還好,其他項目參與人員就更麻煩一些,但我們又不想損失SVN管理的優(yōu)點,所幸我們在Topo項目管理軟件中看到了好的解決方案。

第一步配置好Svn庫:



然后在項目下,配置項目的代碼庫目錄,可能是一個分支,也可以是一個目錄:



這樣就可以瀏覽Svn中的Markdown文件了,很棒的地方在于,Mardown中引用的Svn里的圖片可以正確的顯示出來,這樣就非常方便了:



通過這種方式,我們把大部分項目文檔轉(zhuǎn)到了Markdown格式,方便項目成員隨時修改和瀏覽。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容