VS Code 使用markdown和GIT

起由

和同事一塊兒把如今的產品從新梳理一下,寫一份完整、規範、清晰的PRD文檔。
最終定下來的方式:css

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

試用markdown客戶端

Mac端有一些受歡迎的客戶端,惋惜都不是跨平臺的。因此在PC端要慢慢找,我又有如下這些要求:html

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

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

  • 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路徑添加到環境變量裏。
相關文章
相關標籤/搜索