在VSCode中配置Latex编译环境

摘要

VSCode是一个著名的代码编辑器，因为其多语言支持的特性而被广泛使用。在配合latex扩展的前提下，VSCode也可以用于编译latex文件。这篇文章将会记录如何在VSCode中配置latex编译环境。

步骤一：在你的电脑上安装latex环境

首先，确认电脑上已经安装了latex环境。在本教程中，我们以安装了MiKTeX环境的条件下为例进行操作。

步骤二：安装Latex Workshop扩展

在VSCode中搜索并安装“Latex Workshop”扩展：

步骤三：通过JSON文件打开VSCode设置

你可以根据实际情况把扩展的配置添加到VSCode的用户设置或工作区设置中。在这个例子中，为了方便全局使用该扩展，我们将配置添加到用户设置中，配置用户设置或工作区设置的方法可以参考我的另一篇文章：

步骤四：将编译工具配置添加到用户设置中

“xelatex”、“pdflatex”和“bibtex”是三个常用的编译工具，因此我们将它们配置到文件中，向JSON文件中添加如下代码：

    "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%"
            ]
        }
    ],

步骤五：将编译方案配置添加到用户设置中

编译链可以用不同的方案表示，我们将在这个例子中配置四种常见的编译方案“xelatex”、“pdflatex”、“xe->bib->xe->xe”和“pdf->bib->pdf->pdf”，其中位于第一个的方案将会被作为默认的编译方案：

    "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"
            ]
        }
    ],

（可选）步骤六：高级设置

使用内置pdf浏览器预览pdf文件：

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

按下Ctrl + Alt + V生成预览，每次编译tex文件后，预览将会自动更新。

保存tex文件时自动编译

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

如果你不想在保存时自动编译，则调整配置如下：

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

隐藏在编译出现错误或警告时自动弹出的提示窗口

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

完整的配置文件（可以直接复制到JSON文件中）

{
    "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": "tab",
    "latex-workshop.latex.autoBuild.run": "onFileChange",
    "latex-workshop.message.error.show": false,
    "latex-workshop.message.warning.show": false,
}

报错的解决方法

如果编译时提示perl.exe文件不存在，从官方网站下载perl并安装即可：

https://www.perl.org/get.html#win32

最后

以上步骤后配置就完成了，你可以写一个简单的tex文件进行测试，正常情况下该配置能够编译成功。