Markdown——使用 vs code 配置 Markdown 工作环境 快速编辑文档

这几天趁着春假在整理宏观经济学 dynamic programming 的笔记,因为这部分内容涉及很多数学公式,以及时不时要添加一些数学理论的注解,如果纯手写就太麻烦了,所以我一直在使用 Markdown 整理相关内容,除此之外,我的公众号文章也全部都是用 Markdown 编写的,可以对文档进行快速排版和格式调整。熟悉学术写作工具或者经常使用 GitHub 的同学对 Markdown 肯定不陌生,相比于传统的学术写作工具 LaTeX,前者更为轻便简洁,同时又吸收了后者的一些优点,比如数学公式输入。可以编辑 Markdown 的工具有很多,比如 Typora,vs code 等等,也有很多在线网站支持 Markdown 文档的编辑,比如 mdnice,只要自己用着顺手、合乎自己的习惯都可。Markdown 语法十分简单,不到一个小时就可以掌握,这里不做介绍,请自行谷歌或者百度。

我个人更倾向使用 vs code 进行编辑,vs code 本身是一款十分受欢迎的代码编辑器,特点就是通过各种插件的个性化配置,可以实现一个平台对多种编程语言的运行,比如我常用到的 Python 和 R 语言,以及其他各种个性化的功能,比如阅读编辑文档,编辑 LaTeX,连接 Git 管理代码等等,甚至可以和网易云连接在一起听歌。在刚刚开始学习 Python 的时候,一般都会被推荐使用 Anaconda 的集成安装包,打包下载常用的 module 以及 IDE,比如 Spyder 和 Jupyter Notebook 等等。不过 Anaconda 集成安装的很多 module 以及开发软件我日常根本就用不到,并且 Anaconda 在 Windows 操作系统中会安装独立的 cmd 命令行程序,和系统默认路径不一致,导致我的老旧电脑经常出现问题。后来我就索性卸载了 Anaconda,重新安装了 Python,使用 pip 进行管理,按需下载 module 和 IDE,顿时就觉得清爽了许多。搭配微软开发的 vs code,在 Windows 系统中的使用体验很棒。仅仅安装这一个平台,就满足了我日常的所有使用需求,十分方便。

vs code 默认自带 Markdown 文件的编辑功能,也可以通过安装插件来实现功能扩展。我个人常用的插件有 markdownlint,Markdown+Math,Markdown Preview Enhanced,Markdown All in One 总共就这四个,每个都提供了特定的功能。

Markdown

安装 vs code 配置插件

vs code 的安装十分简单,直接在官网下载安装文件,按照提示安装即可。安装好以后,打开 vs code,点击左侧菜单栏最下面的插件图标,搜索前文四个插件,点击安装即可。选择创建 Markdown 文件,输入文件名称,注意一定要带文件格式 .md 后缀。

Markdown——使用 vs code 配置 Markdown 工作环境 快速编辑文档

点击插件,即可进入该插件的介绍页面。

Markdown——使用 vs code 配置 Markdown 工作环境 快速编辑文档

Markdown All in One

这款插件提供了很多功能,比如 GitHub 风格的文档预览,Markdown 命令自动补全,基本的数学公式输入,快捷键,转为 HTML 格式文件并下载等等。上述这些功能,我唯一需要的就是命令自动补全,其他的主要功能都可由其它更为专精的插件实现。

比如在插入公式时,会出现弹窗提示补全信息,通过电脑的上下方向键选择,按回车键选中,如下图左侧窗口所示。

Markdown——使用 vs code 配置 Markdown 工作环境 快速编辑文档

由于这个插件只能实现基本的数学公式输入,为了获得完整的数学公式输入工具,我们需要安装单独的插件 Markdown+Math,下一小节会详细讲述。由于两个插件会冲突,所以我们需要把 Markdown All in One 插件中的数学公式输入功能关闭。如下图,点击插件标题右下侧的设置图标,选中 extension setting,将设置中的数学功能勾选掉。

Markdown——使用 vs code 配置 Markdown 工作环境 快速编辑文档
Markdown——使用 vs code 配置 Markdown 工作环境 快速编辑文档

Markdown+Math

Markdown+Math 插件可以让我们在 Markdown 文件中使用 LaTeX 语法编辑数学公式,这也是 Markdown 最重要的功能之一了。不过这些插件都是使用 KaTeX 生成数学公式,有某些基础的语句和 LaTeX 并不一致。比如,我们要输入多行数学公式并且对齐,那么传统的 LaTeX 语法是调用 \begin{align} \end{align} 环境,而在 Markdown+Math 的插件功能中,该语句无法别识别,我们需要调用 \begin{aligned} \end{aligned} 或者 \begin{alignedat} \end{alignedat} 环境。这时,就体现出第一个插件的自动补全功能的好处了,只要根据弹窗的提示选择即可。

如果想对 KaTeX 识别的命令有个完整的认识,可以去其官网查看完整的命令列表,大多数时候和 LaTeX 无异。

markdownlint

这个插件可以执行 Markdown 语法的检查。在编辑 Markdown 文档时,如果出现了语法错误,会出现波浪线提示,对错误的地方进行纠正。由此可以帮助我们正确使用 Markdown 语法,使我们编辑的文档的格式具有一致性,方便阅读与传播。

出现波浪线时,将光标移到上面就会出现弹窗提示错误原因,可以选择自动修正,如下图左侧窗口弹窗。也可以使用快捷键,具体查看插件的介绍页面。

Markdown——使用 vs code 配置 Markdown 工作环境 快速编辑文档

Markdown Preview Enhanced

这个插件主要是对 Markdown 文档的风格进行管理,扩展功能(比如编写PPT、插入图表、绘图等等),实现预览功能,对代码块的功能进行扩展插入运行结果,提供多种文档格式的转化下载等等。

下面对几个个性化设置功能做简单介绍,详细的可以参见插件的官方网站。

Markdown 文件编辑界面右上角有两个预览图标,如下图。其中左侧的预览按钮可以打开 Markdown Preview Enhanced 插件的预览效果,右侧的预览按钮可以打开 Markdown All in One 插件的预览效果,打开的预览在右侧窗口显示。由于安装了 Markdown Preview Enhanced 插件,所以我更喜欢这个插件的预览,可以进行更多的个性化设置。

Markdown——使用 vs code 配置 Markdown 工作环境 快速编辑文档

预览界面右上角有三个透明图标,左数第一个可以打开目录,第二个刷新预览,第三个回到文档标题处,如下图。

Markdown——使用 vs code 配置 Markdown 工作环境 快速编辑文档

打开插件的设置,打开下拉列表选择设置预览风格。下面的方框最好勾选,这样可以保证保存的 HTML 格式文件和预览效果一致,下图是三种预览风格的展示。

Markdown——使用 vs code 配置 Markdown 工作环境 快速编辑文档
Markdown——使用 vs code 配置 Markdown 工作环境 快速编辑文档
Markdown——使用 vs code 配置 Markdown 工作环境 快速编辑文档

我们也可以设置代码块的风格,打开下拉列表选择,如下图。

Markdown——使用 vs code 配置 Markdown 工作环境 快速编辑文档

我们也可以选择执行代码插入执行结果,在设置中勾选设定,如下图。

Markdown——使用 vs code 配置 Markdown 工作环境 快速编辑文档

然后在插入代码的时候需要加入参数 cmd=true,如果调用 matplotlib 绘图还需要设置 matplotlib=true,如下图。

Markdown——使用 vs code 配置 Markdown 工作环境 快速编辑文档

在右侧的预览界面中,光标移到代码块,可以看到两个图标,右侧即为运行按钮,运行的结果就会被插入文档中。

Markdown——使用 vs code 配置 Markdown 工作环境 快速编辑文档

最后,如果需要保存文件,在右侧预览界面,右击鼠标即可打开选择。我个人倾向保存为 HTML 格式文档,用浏览器即可打开查阅。这里不推荐直接保存为 PDF 文档,保存为 HTML 格式文档后,可以在浏览器中选择保存为 PDF 格式文档。点击左下侧图标,可打开目录,如下图。

Markdown——使用 vs code 配置 Markdown 工作环境 快速编辑文档
Markdown——使用 vs code 配置 Markdown 工作环境 快速编辑文档

来源:爱尔兰粉公爵,本文观点不代表自营销立场,网址:https://www.zyxiao.com/p/125578

发表评论

登录后才能评论
侵权联系
返回顶部