用 VSCode 编辑 Markdown
Markdown 是一种轻量级标记语言,可以方便的转化成 HTML,PDF 等其他格式。
编辑增强
Markdown All in One 可以为 Markdown 编辑提供更好的体验。
预览
Markdown Preview Enhanced 是一个预览插件,它支持 Markdown 的扩展功能。譬如数学公式,表格等等。但是,VuePress 和 MKDocs 等静态站点生成器会通过各种插件来增加 Markdown 的功能,这时候 Markdown Preview Enhanced 就不能完全预览了。
代码格式化
格式化工具可以保证 Markdown 的源码格式一致,对 git 这类源代码管理工具十分友好。我们使用两个插件
- prettier,它支持 Markdown 以及很多其他语言。
- pangu-markdown,它可以自动在中文和英文之间添加空格,避免中文和英文混合在一起时的排版问题。
值得一提的是,最新的 prettier 不支持在中英文之间加空白。在添加盘古之白的插件中,pangu-markdown 兼容性是好的,不会做不必要的操作。
语法检查
语法检查由 markdownlint 插件实现。会在编辑的过程中,自动对 Markdown 的语法进行检查,并将问题显示在 VSCode 的问题标签中。它有一个配置文件.markdownlint.json,可以对检查的项目进行定制。
配置文件
修改一下 VSCode 的设置 settings.json,添加关于 Markdown 文件的配置。由于各类项目都会用到 Markdown,所以应当尽可能让这个设置处于比较的全局的位置。
...
"[markdown]": {
"editor.wordWrap": "wordWrapColumn",
"editor.wordWrapColumn": 120,
"editor.defaultFormatter": "prettier.prettier-vscode",
"prettier.proseWrap": "preserve", // 一段文字超出宽度,保留原样
},
"pangu.auto_format_on_save": true,
...