使用VSCode编写LaTeX

点击上方“程序员大白”，选择“星标”公众号
重磅干货，第一时间送达

来自 | 知乎

作者 | Marvey

地址 | https://zhuanlan.zhihu.com/p/38178015

编辑 | 机器学习算法与自然语言处理公众号

本文仅作学术分享，若侵权，请联系后台删文处理

许多人都是用 texstudio 或者 winedt 配合 texlive 编写  文档，很长一段时间内 texstudio 是我唯一的编辑器，然而，颜控的我受不了那原始的界面，于是我看上了 VSCode。漂亮、免费、开源是我选择 VSCode 的主要原因。

网上有很多介绍 VSCode +  的文章，不过在配置外部阅读器的介绍稍微有点少，我在网上找了很久才在 LaTeX Workshop 作者的 github 主页上找到方法，同时也萌发了写一篇教程的想法。

本文主要介绍使用 VSCode 编写简单的文档以及设置外部PDF阅读器的方法。

如果你已经安装好了 texlive、VSCode 和 SumatraPDF，并且不想看完整篇文章，只想快点上手，请翻到文章末尾的附录，将代码全部复制到 VSCode 的设置里，然后把“...”的地方替换成软件在自己电脑上的路径，然后就可以使用了。

1. 安装 texlive

可以从以下网址下载 texlive 的镜像文件：

mirrors.huaweicloud.com

mirrors.aliyun.com/CTAN

其他高校的开源镜像站像清华、中科大也可以，但是速度上我感觉还是华为云和阿里云的更快一点。

加载 texlive 2020 的 iso 文件，

 右键 install-tl-windows，单击以管理员身份运行，进入安装界面，点击左下角的“Advanced”进入高级安装来取消你不需要安装的宏包。

 点击“Customize”来取消勾选不需要的宏包。

 单是把非中英的语言包取消勾选可以省掉 1G 的空间，要是嫌麻烦全部安装也可以。

安装界面右下角可选择是否安装 TeXworks 编辑器，我觉得既然都来看这篇文章了，那这个应该可以不要了。设置完安装路径等选项之后点击“安装”，之后静坐 20 分钟 - 3 小时等待安装完成。

2. 安装 VSCode 上的  插件

与此同时，下载 VSCode 并安装，VSCode 的安装很简单，这里就不唠叨了。

 VSCode 安装完成之后，在扩展商店安装 LaTeX Workshop 插件。

安装完成后，随便打开一个 tex 源文件，

 可以看到，代码已经被高亮显示。

3. 配置 VSCode 的  插件

在 VSCode 界面下按下 F1，然后键入“setjson”，点击“首选项: 打开设置(JSON)”，

将以下代码放入设置区：

"latex-workshop.latex.tools": [
    {
        // 编译工具和命令
        "name": "xelatex",
        "command": "xelatex",
        "args": [
            "-synctex=1",
            "-interaction=nonstopmode",
            "-file-line-error",
            "-pdf",
            "%DOCFILE%"
        ]
    },
    {
        "name": "pdflatex",
        "command": "pdflatex",
        "args": [
            "-synctex=1",
            "-interaction=nonstopmode",
            "-file-line-error",
            "%DOCFILE%"
        ]
    },
    {
        "name": "bibtex",
        "command": "bibtex",
        "args": [
            "%DOCFILE%"
        ]
    }
],

 LaTeX Workshop 默认的编译工具是 latexmk，大家根据需要修改所需的工具和命令，我不需要用到 latexmk，因此我把其修改为中文环境常用的 xelatex，大家根据需要自行修改。（感谢 

@huan Yu

 ，将 tools 中的 %DOC%替换成%DOCFILE%就可以支持编译中文路径下的文件了）

"latex-workshop.latex.recipes": [
    {
        "name": "xelatex",
        "tools": [
            "xelatex"
        ],
    },
    {
        "name": "pdflatex",
        "tools": [
            "pdflatex"
        ]
    },
    {
        "name": "xe->bib->xe->xe",
        "tools": [
            "xelatex",
            "bibtex",
            "xelatex",
            "xelatex"
        ]
    },
    {
        "name": "pdf->bib->pdf->pdf",
        "tools": [
            "pdflatex",
            "bibtex",
            "pdflatex",
            "pdflatex"
        ]
    }
],

 用于配置编译链，同样地放入设置区。第一个 recipe 为默认的编译工具，如需要使用 bibtex 可使用如下方法：

1. 在编译时单击 VSCode 界面左下角的小勾，单击“Build LaTeX project”，选择带 bib 的 Recipe，也可使用快捷键快速选择；

2. 将带 bib 的 Recipe 放到第一位，就可以作为默认 Recipe 编译了，也可以但因为编译次数比较多，速度会比较慢；

3. 在文档的开头添加 %!BIB program = bibtex

要使用 pdflatex，只需在 tex 文档首加入以下代码：

%!TEX program = pdflatex

要使用 SumatraPDF 预览编译好的PDF文件，添加以下代码进入设置区。

"latex-workshop.view.pdf.viewer": "external",

"latex-workshop.view.pdf.external.viewer.command": "C:/.../SumatraPDF.exe",
"latex-workshop.view.pdf.external.viewer.args": [
    "-forward-search",
    "%TEX%",
    "%LINE%",
    "-reuse-instance",
    "-inverse-search",
    "\"C:/.../Microsoft VS Code/Code.exe\" \"C:/.../Microsoft VS Code/resources/app/out/cli.js\" -gr \"%f\":\"%l\"",
    "%PDF%"
],

 “viewer”选择使用外置阅读器，“viewer.command”和 “viewer.args”中有“...”的地方需要根据自己电脑上 SumatraPDF 和 VSCode 的安装位置进行修改，记得把盘符也改了。

现在就可以使用 VSCode 编译 tex 文件并以 SumatraPDF 为阅读器预览了。

 插件经过几次更新之后已经去掉了右键菜单选项，选项被移动到了左侧栏。点击左侧栏的  图标，再点击你所想要使用的 Recipe 就可以编译了，如果用快捷键则默认使用第一条 Recipe 编译。单击右上角的放大镜按钮或按 Ctrl+Alt+v 打开 SumatraPDF 进行预览。

4. 配置正向和反向搜索

"latex-workshop.view.pdf.external.synctex.command": "C:/.../SumatraPDF.exe",
"latex-workshop.view.pdf.external.synctex.args": [
    "-forward-search",
    "%TEX%",
    "%LINE%",
    "-reuse-instance",
    "-inverse-search",
    "\"C:/.../Microsoft VS Code/Code.exe\" \"C:/.../Microsoft VS Code/resources/app/out/cli.js\" -gr \"%f\":\"%l\"",
    "%PDF%",
],

 添加代码进入设置区以配置正向搜索，和上面一样，里面“...”的部分结合自身情况修改（感谢 

@Macrofuns

 指出，如果不加双引号，在文件路径有空格的情况下会导致无法反向搜索）。

 单击“SyncTeX from cursor”即可正向搜索。

 可以看到，光标所在的行的内容在 PDF 中高亮显示（可以自己配置快捷键，我设置的是 Alt + S）。

 在PDF中双击即可反向搜索

不要清理生成的名字中带 synctex 的文件，否则就不能进行正向和反向搜索；

之前的文章中，我提到了从 VSCode 预览按钮启动 SumatraPDF 会无法反向搜索的问题，现在已经解决，解决方法是在反向搜索命令中添加

"resources\app\out\cli.js"

解决方案来源：

https://github.com/James-Yu/LaTeX-Workshop/issues/637#issuecomment-473145503

这个方法目前有个 bug，SumatraPDF 要从 VSCode 中打开才能进行反向搜索，单独打开的 SumatraPDF 在进行反向搜索时会跳转到 VSCode 的配置文件 cli.js。

6. 快捷键设置

在 VSCode 界面下按下 F1，键入“keyjson”，选择“打开键盘快捷方式(JSON)”，然后把以下代码放入：

{
    "key": "alt+s",
    "command": "latex-workshop.synctex",
    "when": "editorTextFocus && !isMac"
},
{
    "key": "alt+b",
    "command": "latex-workshop.build",
    "when": "editorTextFocus && !isMac"
},
{
    "key": "alt+t",
    "command": "latex-workshop.kill",
    "when": "editorTextFocus && !isMac"
},
{
    "key": "alt+e",
    "command": "latex-workshop.recipes"
},

这段代码的意义是将 Alt+s 绑定到正向搜索，将 Alt+b 绑定到使用默认 recipe 编译，将 Alt+t 绑定到终止编译，将 Alt+e 绑定到选择其他 recipe 编译，可以自行更换为适合自己的快捷键，只需修改“key”那一项即可。

7. 其他设置

• LaTeX Workshop 默认保存的时候自动编译，如果不喜欢这个设置，可以添加以下代码进入设置区：

"latex-workshop.latex.autoBuild.run": "never",

• 如果编译出错，插件会弹出两个很烦人的气泡，不喜欢的话可以在设置中添加以下代码：

"latex-workshop.message.error.show": false,
"latex-workshop.message.warning.show": false,

附录

注意：只需把以下代码放入设置区的方括号里，不要删去方括号，不要忘记替换软件的路径。

// LaTeX
"latex-workshop.latex.autoBuild.run": "never",
"latex-workshop.message.error.show": false,
"latex-workshop.message.warning.show": false,

"latex-workshop.latex.tools": [
    {
        "name": "xelatex",
        "command": "xelatex",
        "args": [
            "-synctex=1",
            "-interaction=nonstopmode",
            "-file-line-error",
            "%DOCFILE%"
        ]
    },
    {
        "name": "pdflatex",
        "command": "pdflatex",
        "args": [
            "-synctex=1",
            "-interaction=nonstopmode",
            "-file-line-error",
            "%DOCFILE%"
        ]
    },
    {
        "name": "bibtex",
        "command": "bibtex",
        "args": [
            "%DOCFILE%"
        ]
    }
],

"latex-workshop.latex.recipes": [
    {
        "name": "xelatex",
        "tools": [
            "xelatex"
        ],
    },
    {
        "name": "pdflatex",
        "tools": [
            "pdflatex"
        ]
    },
    {
        "name": "xe->bib->xe->xe",
        "tools": [
            "xelatex",
            "bibtex",
            "xelatex",
            "xelatex"
        ]
    },
    {
        "name": "pdf->bib->pdf->pdf",
        "tools": [
            "pdflatex",
            "bibtex",
            "pdflatex",
            "pdflatex"
        ]
    }
],
"latex-workshop.view.pdf.viewer": "external",

"latex-workshop.view.pdf.external.viewer.command": "C:/.../SumatraPDF.exe",
"latex-workshop.view.pdf.external.viewer.args": [
    "-forward-search",
    "%TEX%",
    "%LINE%",
    "-reuse-instance",
    "-inverse-search",
    "\"C:/.../Microsoft VS Code/Code.exe\" \"C:/.../Microsoft VS Code/resources/app/out/cli.js\" -gr \"%f\":\"%l\"",
    "%PDF%"
],

"latex-workshop.view.pdf.external.synctex.command": "C:/.../SumatraPDF.exe",
"latex-workshop.view.pdf.external.synctex.args": [
    "-forward-search",
    "%TEX%",
    "%LINE%",
    "-reuse-instance",
    "-inverse-search",
    "\"C:/.../Microsoft VS Code/Code.exe\" \"C:/.../Microsoft VS Code/resources/app/out/cli.js\" -gr \"%f\":\"%l\"",
    "%PDF%",
],

推荐阅读
国产小众浏览器因屏蔽视频广告，被索赔100万（后续）
年轻人“不讲武德”：因看黄片上瘾，把网站和786名女主播起诉了
中国联通官网被发现含木马脚本，可向用户推广色情APP
张一鸣：每个逆袭的年轻人，都具备的底层能力

关于程序员大白

程序员大白是一群哈工大，东北大学，西湖大学和上海交通大学的硕士博士运营维护的号，大家乐于分享高质量文章，喜欢总结知识，欢迎关注[程序员大白]，大家一起学习进步！