Markdown在項目中的實踐

在Markdown以前,咱們使用Word編輯項目文檔,基本上只能一我的編輯文檔,並且若是用多臺機器也不太方便,一不當心忘記更新就會致使沒法合併。Mardown無需多言,由於純文本格式,很是適合多人編輯文檔,咱們在項目中推廣Markdown,把Markdown文檔放在Svn中,這樣完美的解決了文檔的持續更新問題,無論是多人仍是多臺機器編輯,都和編輯普通代碼沒什麼區別了,文本的合併使用很成熟的方法便可。程序員

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

第一步配置好Svn庫:圖片

clipboard.png

而後在項目下,配置項目的代碼庫目錄,多是一個分支,也能夠是一個目錄:ip

clipboard.png

這樣就能夠瀏覽Svn中的Markdown文件了,很棒的地方在於,Mardown中引用的Svn裏的圖片能夠正確的顯示出來,這樣就很是方便了:項目管理

clipboard.png

經過這種方式,咱們把大部分項目文檔轉到了Markdown格式,方便項目成員隨時修改和瀏覽。文檔

相關文章
相關標籤/搜索