上节《用Markdown撰写IT技术文档、博客和电子书》讲述了为什么要用Markdown撰写技术文档,以及使用Typora撰写技术文档。使用Typora撰写技术文档,虽然方便,但编写Python代码用VS Code,编写项目README.md文档需要切换到Typora,不够方便,违背所有工作在同一平台上完成的原则,本文介绍在VS Code中编写Markdown文档,将编写项目README.md的工作集成到VS Code中。
VS Code原生支持markdown语法,新建一个README.md文件,VS Code会根据文件的后缀.md,自动识别并启动markdown编辑;点击分栏显示按钮,可以一边编写markdown文件,一边预览markdown文件效果。
既然在VS Code中使用markdown大部分是为了编写Github的README.md文档,那么有一个Github风格的预览区,更加有助于所见即所得的排版编辑,所以,推荐安装Markdown Preview Github Styling插件;另外,数学公式编辑也非常重要,推荐安装Markdown+Math插件。
在写作实践中,最常用的Markdown语法:
进阶阅读:《在VS Code中实现Python源代码版本管理:本地仓》