一、前期准备
(一)安装 VSCode
VSCode 是一款轻量级但功能强大的代码编辑器,支持多种编程语言,并且拥有丰富的插件生态系统,非常适合用于编写 Markdown 文档。你可以在VSCode 官网下载对应系统的安装包,下载完成后,按照安装向导的指引完成安装。安装后,你既可以在命令行输入code
启动 VSCode,也可以直接点击软件图标启动。
(二)安装相关插件
- Markdown All in One:这款插件为 Markdown 编写提供了诸多基础功能增强,比如丰富的快捷键操作(如
Ctrl + B
加粗、Ctrl + I
斜体、Alt + S
添加删除线等)、便捷的列表编辑功能、自动生成目录等,极大地提升 Markdown 编写体验。在 VSCode 的扩展商店中搜索 “Markdown All in One”,点击安装并等待安装完成,安装结束后重新加载以使插件生效。 - Markdown Preview Enhanced:实现类似 GitHub 风格的 Markdown 预览效果,同时支持将 Markdown 文档导出为 HTML、PDF 等格式。同样在扩展商店搜索该插件名称进行安装。安装完成后,它可以让你在编写过程中更直观地查看文档最终呈现效果,并且方便将文档分享或转换为其他常用格式。
- markdownlint:提供 Markdown 语法提示与智能纠错功能,帮助你及时发现并修正 Markdown 语法错误,保证文档编写的规范性。在扩展商店中搜索并安装该插件后,通过文档右键【使用... 格式化文档】-【配置默认格式化程序】选择
markdownlint
,可以将其设置为默认的 Markdown 格式化工具。后续编写时,可通过Ctrl+Shift+M
查看打开的所有 Tab 标签文档中的语法警告,按F8
查看当前位置的警告信息。 - 如果需要运行代码块,针对不同语言安装特定插件:
- Python:若要运行 Python 代码块,安装 “Python” 插件(由 Microsoft 官方开发)。该插件提供 Python 语法高亮、调试功能以及代码智能提示等功能,为 Python 代码编写与运行提供支持。安装后,在 VSCode 中编写 Python 代码时会有更友好的编辑体验,且能方便地运行代码块。
- C/C++:对于 C 和 C++ 代码,需安装 “C/C++” 插件,它能提供语法检查、智能代码补全、调试支持等功能。安装后,在 Markdown 中编写的 C/C++ 代码块可以进行语法检查,为运行代码块做好准备。在扩展商店搜索 “C/C++” 找到对应的插件进行安装。
二、创建 Markdown 文档
打开 VSCode,通过以下步骤创建 Markdown 文档: