? ? ? 上節(jié)《用Markdown撰寫(xiě)IT技術(shù)文檔、博客和電子書(shū)》講述了為什么要用Markdown撰寫(xiě)技術(shù)文檔,以及使用Typora撰寫(xiě)技術(shù)文檔。使用Typora撰寫(xiě)技術(shù)文檔,雖然方便,但編寫(xiě)Python代碼用VS Code,編寫(xiě)項(xiàng)目README.md文檔需要切換到Typora,不夠方便,違背所有工作在同一平臺(tái)上完成的原則,本文介紹在VS Code中編寫(xiě)Markdown文檔,將編寫(xiě)項(xiàng)目README.md的工作集成到VS Code中。
? ? ?VS Code原生支持markdown語(yǔ)法,新建一個(gè)README.md文件,VS Code會(huì)根據(jù)文件的后綴.md,自動(dòng)識(shí)別并啟動(dòng)markdown編輯;點(diǎn)擊分欄顯示按鈕,可以一邊編寫(xiě)markdown文件,一邊預(yù)覽markdown文件效果。

? ? ? 既然在VS Code中使用markdown大部分是為了編寫(xiě)Github的README.md文檔,那么有一個(gè)Github風(fēng)格的預(yù)覽區(qū),更加有助于所見(jiàn)即所得的排版編輯,所以,推薦安裝Markdown Preview Github Styling插件;另外,數(shù)學(xué)公式編輯也非常重要,推薦安裝Markdown+Math插件。

在寫(xiě)作實(shí)踐中,最常用的Markdown語(yǔ)法:

進(jìn)階閱讀:《在VS Code中實(shí)現(xiàn)Python源代碼版本管理:本地倉(cāng)》