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路径添加到环境变量里。
原文地址:https://www.cnblogs.com/woodytian/p/5169034.html