使用VSCode编写LaTeX(latex+vscode+SumatraPDF

许多人都是用 texstudio 或者 winedt 配合 texlive 编写文档很长一段时间内 texstudio 是我唯一的编辑器然而颜控的我受不了那原始的界面于是我看上了 VSCode。漂亮、免费、开源是我选择 VSCode 的主要原因。网上有很多介绍 VSCode 的文章不过在配置外部阅读器的介绍稍微有点少我在网上找了很久才在 LaTeX Workshop 作者的 github 主页上找到方法同时也萌发了写一篇教程的想法。本文主要介绍使用 VSCode 编写简单的文档以及设置外部PDF阅读器的方法。如果你已经安装好了 texlive、VSCode 和 SumatraPDF并且不想看完整篇文章只想快点上手请翻到文章末尾的附录将代码全部复制到 VSCode 的设置里然后再根据第5节设置一下反向搜索就可以使用了。1. 安装 texlive加载 texlive 2019 的 iso 文件右键 install-tl-windows单击以管理员身份运行进入安装界面。可以点击“Advanced”进入高级安装来取消你不需要安装的宏包。高级安装界面点击“Customize”来取消勾选不需要的宏包。很多宏包和功能我个人并不需要因此我在这里取消勾选大家可以根据需要勾选自己需要的功能如果嫌麻烦全部安装也可以并不消耗多少空间。设置完安装路径等选项之后点击“安装”之后静坐 20 分钟等待安装完成。2. 安装 VSCode 上的插件与此同时下载 VSCode 并安装VSCode 的安装很简单这里就不唠叨了。VSCode 安装完成之后在扩展商店安装 LaTeX Workshop 插件。安装完成后随便打开一个 tex 源文件可以看到代码已经被高亮显示。3. 配置 VSCode 的插件将以下代码放入 VSCode 的设置区内。latex-workshop.latex.tools: [ { // 编译工具和命令 name: xelatex, command: xelatex, args: [ -synctex1, -interactionnonstopmode, -file-line-error, -pdf, %DOCFILE% ] }, { name: pdflatex, command: pdflatex, args: [ -synctex1, -interactionnonstopmode, -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: xe-bib-xe-xe, tools: [ xelatex, bibtex, xelatex, xelatex ] } ],用于配置编译链同样地放入设置区。第一个 recipe 为默认的编译工具如需要使用 bibtex 可在编译时单击 VSCode 界面左下角的小勾单击“Build LaTeX project”选择“xe-bib-xe-xe”另外的方法是使用右侧栏或者直接将“xe-bib-xe-xe”的Recipe 放到第一位就可以作为默认 Recipe 编译了但因为编译次数比较多速度会比较慢。大家可以根据需要自行按照格式添加自己需要的编译链。要使用 pdflatex只需在 tex 文档首加入以下代码%!TEX program pdflatex要使用 SumatraPDF 预览编译好的PDF文件添加以下代码进入设置区。latex-workshop.view.pdf.viewer: external, latex-workshop.view.pdf.external.command: { command: E:/Programs/SumatraPDF/SumatraPDF.exe, args: [ %PDF% ] },“viewer”设置阅读器为外置阅读器“command”为 SumatraPDF.exe 的路径根据具体情况修改。现在就可以使用 VSCode 编译 tex 文件并以 SumatraPDF 为阅读器预览了。插件经过几次更新之后已经去掉了右键菜单选项选项被移动到了右侧栏。点击右侧栏的图标再点击你所想要使用的Recipe就可以编译了如果用快捷键则默认使用第一条 Recipe 编译。或者也可以使用快捷键 CtrlAltV。单击右上角的按钮即可打开 SumatraPDF 并预览。4. 配置正向搜索latex-workshop.view.pdf.external.synctex: { command: E:/Programs/SumatraPDF/SumatraPDF.exe, args: [ -forward-search, %TEX%, %LINE%, %PDF% ] },添加代码进入设置区以配置正向搜索。“command”依旧是 SumatraPDF.exe 的存放位置根据具体情况修改。单击“SyncTeX from cursor”即可正向搜索。可以看到光标所在的行的内容在 PDF 中高亮显示。5. 配置反向搜索打开 SumatraPDF进入设置-选项-设置反向搜索命令行添加以下命令Code.exe resources\app\out\cli.js -g %f:%l根据 VSCode 具体的安装位置将“Code.exe”和“resources\app\out\cli.js”换成 VSCode 在自己的电脑上的安装位置例如C:\Users\Marvey\AppData\Local\Programs\Microsoft VS Code\Code.exe C:\Users\Marvey\AppData\Local\Programs\Microsoft VS Code\resources\app\out\cli.js -g %f:%l感谢Macrofuns指出如果不加双引号在文件路径有空格的情况下会导致无法反向搜索双击 PDF 中的任意一处即可跳转到 VSCode 中所对应的内容的源代码处。这样 VSCode texlive 就完全配置好了。最好不要清理 xelatex 生成的 gz 后缀的临时文件否则就不能进行正向和反向搜索之前的文章中我提到了从 VSCode 预览按钮启动 SumatraPDF 会无法反向搜索的问题现在已经解决解决方法是在反向搜索命令中添加resources\app\out\cli.js解决方案来源Synctex inverse search doesnt work half the time (and How I got forward search to work for SumatraPDF) · Issue #637 · James-Yu/LaTeX-Workshop​github.com​编辑6. 其他设置LaTeX Workshop 默认保存的时候自动编译如果不喜欢这个设置可以添加以下代码进入设置区latex-workshop.latex.autoBuild.run: never,附录// LaTeX latex-workshop.latex.tools: [ { name: xelatex, command: xelatex, args: [ -synctex1, -interactionnonstopmode, -file-line-error, -pdf, %DOCFILE% ] }, { name: pdflatex, command: pdflatex, args: [ -synctex1, -interactionnonstopmode, -file-line-error, %DOCFILE% ] }, { name: bibtex, command: bibtex, args: [ %DOCFILE% ] } ], latex-workshop.latex.recipes: [ { name: xelatex, tools: [ xelatex ] }, { name: xe-bib-xe-xe, tools: [ xelatex, bibtex, xelatex, xelatex ] }, { name: pdflatex, tools: [ pdflatex ] } ], latex-workshop.view.pdf.viewer: external, latex-workshop.view.pdf.external.command: { // ********** command: C:/Program Files/SumatraPDF/SumatraPDF.exe, // 注意修改路径 args: [ // ********** %PDF% ] }, latex-workshop.view.pdf.external.synctex: { // ********** command: C:/Program Files/SumatraPDF/SumatraPDF.exe, // 注意修改路径 args: [ // ********** -forward-search, %TEX%, %LINE%, %PDF% ] },问题描述vscode更新1.111.0后之前配置的latex workshop和Sumatra PDF不能反向搜索了从pdf定位到tex。上网搜索尝试了诸多方法无果至少效果不完美。有的必须单独打开Sumatra不能从vs打开被视作vs子进程无法反向搜索有的在反向定位时会出现1秒左右的命令行黑框影响观感。解决方法总共3步latex workshop配置也需不用改Sumatra PDF根目录下创建vbs脚本修改Sumatra PDF的反向搜索命令行。latex workshop配置我当前的配置如下仅供参考(注意按照本地路径填写)//使用 SumatraPDF 预览编译好的PDF文件 // 设置VScode内部查看生成的pdf文件 latex-workshop.view.pdf.viewer: external, //可改为tab : 使用 vscode 内置 pdf 查看器 // PDF查看器用于在\ref上的[View on PDF]链接 latex-workshop.view.pdf.ref.viewer:auto, // 使用外部查看器时要执行的命令。此功能不受官方支持。 latex-workshop.view.pdf.external.viewer.command: D:/somesoftware/SumatraPDF/SumatraPDF.exe, // 注意修改路径 // 使用外部查看器时latex-workshop.view.pdf.external.view .command的参数。此功能不受官方支持。%PDF%是用于生成PDF文件的绝对路径的占位符。 latex-workshop.view.pdf.external.viewer.args: [ -reuse-instance, %PDF% ], // 将synctex转发到外部查看器时要执行的命令。此功能不受官方支持。 latex-workshop.view.pdf.external.synctex.command: D:/somesoftware/SumatraPDF/SumatraPDF.exe, // 注意修改路径 // latex-workshop.view.pdf.external.synctex的参数。当同步到外部查看器时。%LINE%是行号%PDF%是生成PDF文件的绝对路径的占位符%TEX%是触发syncTeX的扩展名为.tex的LaTeX文件路径。 latex-workshop.view.pdf.external.synctex.args: [ -forward-search, %TEX%, %LINE%, -reuse-instance, %PDF%, ],2. Sumatra PDF根目录下创建vbs脚本脚本内容如下Set WshShell CreateObject(WScript.Shell) If WScript.Arguments.Count 2 Then file WScript.Arguments(0) line WScript.Arguments(1) 0 代表隐藏窗口后台运行完美消除黑框 cmd cmd.exe /c code.cmd -r -g file : line WshShell.Run cmd, 0, False End If脚本命名为silent_code.vbs3. 修改Sumatra PDF的反向搜索命令行点开Sumatra PDF左上角3道横杠选择“设置”再选择“选项”打开后在“设置反向搜索命令行”的编辑框中输入如下内容(注意按照本地路径填写)wscript D:\somesoftware\SumatraPDF\silent_code.vbs %f %l