VS Code 使用markdown和GIT


起由

和同事一起把現在的產品重新梳理一下,寫一份完整、規范、清晰的PRD文檔。
最終定下來的方式:

  • 最終選定使用markdown格式來寫
  • 使用GIT來同步,他找到一個可創建私有倉庫的GIT(bitbucket)
  • 成品做一個WIKI網站。前后試用過mediawiki/pmwiki/gitbook/dokuwiki,最終暫定使用dokuwiki

試用markdown客戶端

Mac端有一些受歡迎的客戶端,可惜都不是跨平台的。所以在PC端要慢慢找,我又有以下這些要求:

  • 外觀最好美觀
  • 支持的格式不用太多,但是也盡量不要僅支持原生markdown
  • 用起來方便的
  • 最好能直接導出PDF
  • 有文件夾管理最好,整套文件管理次之
  • 一定要客戶端,而不是見面版
  • 免費版最佳

把市面上推薦能用的markdown基本上都試用了一遍,最終沒有一個完美的程序,但是有幾個可選項:

  • haroopad,是一個韓國的開源程序,界面和易用性都不錯,可以直接導出PDF(最開始沒發現怎么導出。但是導出發現並不是非常好,基本和導出html再用chrome轉成PDF是一樣的效果,有些格式轉不過去),有多種編輯模式(用這個軟件,我學會了vim的基本操作方法),語法夠用,不過還有一些簡單的私有語法,所以和其他同事合作的時候會有點麻煩,非常可惜的是沒有文件管理方案,略不方便。
  • CuteMarkEd,也是一款開源軟件,界面稍簡陋,語法支持比haroopad稍差,能導出PDF,但是導出的樣式有點慘不忍睹,不過勝在有文件管理(猶豫再三,我再是把他卸載掉了)
  • Cmd Markdown/馬克飛象/StackEdit/小書匠,這些本質上都是網頁版,不過有些是有客戶端的,然后有不同程度的收費項。不過在功能和美觀度上是最領我滿意的,可惜網頁版感覺效率上差點事,而且文件管理甚至簡單的打開文件也不是很方便。
  • VS Code,關於VS Code的稱贊有很多,用它來寫markdown也提供了即時預覽功能,預覽的樣式其實也可以自定義,不過支持的語法並不是很多是一大遺憾。最后一點,VS Code支持GIT,目前我們的文檔並不是很復雜,只用基本的markdown語法也能滿足,再加上GIT功能,一個VS Code就可以滿足我了,所以還是不錯的

VS Code配置

  • VS Code雖然說安上就能用,但是原生的markdown並不是很好看,可以修改默認的markdown.css文件,調整成自己喜歡的樣式。當然目前我還沒有調好,搞來搞去一團糟。
  • GIT配置,其實也簡單,不過有幾個注意點
  1. VS Code時提供的下載鏈接是v2.7.0,但是在安裝的時候win10系統會攔截,要記住這時候也是可以安裝的,只要點左下角的“自定義”還是什么按鈕就可以了
  2. 安裝好之后,雖然我重啟了VS Code,甚至重啟了電腦,自己新建文件夾並且用GIT客戶端同步了幾遍,但是在VS Code里就是不能用,沒打開文件夾的時候提示there is no currently opened folder,打開文件夾之后提示it looks like git is not installed on your system,最后才發現是要配置PATH,把GIT/cmd路徑添加到環境變量里。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM