VS Code + LaTex + SumatraPDF联合使用指南

VS Code 与 TexLive SumatraPDF 下载安装我们就以TexLive为排版系统用VS Code做编辑器我本来也是有安装TexStudio的但因为一直用的VS Code比较习惯并且VS Code的界面个人感觉要比TexStudio要好看一些最重要的是VS Code可以用Copilot对于我来说就很方便。只是需要在VS Code上配置一下Latex环境就好。 VS Code下载安装没有任何限制安装即用。 TexLive的下载安装可参考我的另一篇博客TexLive和TeXstudio的下载与安装。其中涉及正常安装和非正常安装两种场景。⬇️ SumatraPDF的下载下载地址Download SumatraPDF点进下载网址之后每个系统都有两个选项SumatraPDF-3.6-64-install.exe SumatraPDF-3.6-64.zip我先下载了.zip版的这个是轻量版本解压即用不会影响到电脑的环境变量。但我用这个版本时每次打开都很慢还会弹出一个提示我觉得很烦就由下载了-install.exe完成安装。️ SumatraPDF的使用VS Code有内置PDF阅读器插件可以安装插件使用但有这样几个原因导致我换上了SumatraPDF打破文件占用当然这一点针对的并不是VS Code的内置PDF而是使用外部PDF阅读器。外部PDF阅读器打开了PDF后就会把这个文件**“锁死”**。LaTeX 编译器根本没有权限去覆盖和更新它必须手动关掉阅读器重新编译再重新打开。SumatraPDF 是极其罕见的**“不锁文件”的阅读器。它只把 PDF 读进内存然后就松手了。当 LaTeX 在后台偷偷把 main.pdf 覆盖更新后SumatraPDF 会敏锐地察觉到变化并在零点几秒内自动无缝刷新**你连闪烁都感觉不到画面就已经更新了。方便双屏协作VS Code的内置PDF是没办法双屏的对于我来说就很难受我喜欢一个屏幕放代码另一个屏幕放PDF这样代码也显得整齐好看一些不坏眼睛。如果用外置阅读器其它阅读器就会遇到“文件占用”的问题。而SumatraPDF作为一个独立的轻量级原生程序你可以把它直接甩到第二块屏幕上或者在单屏幕上用 Alt Tab 极其丝滑地切屏。代码视窗想拉多大就拉多大这才是真正的生产力布局。方便双向跳转虽然 VS Code 的内置阅读器也能跳转但由于它是基于浏览器内核的渲染极其复杂的超大几百兆 PDF 时不仅容易卡顿掉帧跳转定位也经常漂移。而 SumatraPDF 是用底层 C 写的纯粹阅读器极度轻量只有几 MB几千页的博士论文秒开双击跳转的精准度更是指哪打哪。在 SumatraPDF 里看到哪里有错别字直接双击鼠标左键VS Code 会像被施了魔法一样光标瞬间跳到那一行源代码 VS Code的Latex环境配置环境配置我参考了这个博主的博客Visual Studio Code (vscode)配置LaTeX。更多的避坑参考我的另一篇博客VS Code LaTeX 终极避坑与配置指南。 安装LaTeX Workshop插件在VS Code的插件市场里搜索LaTeX Workshop安装即可。安装后会自动识别系统中安装的TeX发行版如TeX Live并且会自动配置好编译器路径。此时放入一个工程看看能不能编译成功。 打开PDF预览界面在编译成功后按下Ctrl Alt V快捷键查看是否正常出现PDF预览界面。如果此时不正常就要查看一下自己的设置了。我遇到的一个坑我在电脑A上建立了一个Latex工程其中包含一个文件夹.vscode下面有setting.json文件里面是电脑A中关于VS Code的设置。我将这个Latex工程移到电脑B后并未更改电脑B中关于VS Code的设置即setting.json文件。也就是说我在电脑B上的Latex工程中有来两个setting.json文件但其优先以工程中的配置文件运行这样就导致打开PDF预览冲突。出现了编译成功但没有PDF显示的现象。此时有两个解决方法一是直接删除工程中的setting.json文件或其中关于Latex-workshop的设置二是将其中关于PDF的路径设置正常。 实现SumatraPDF预览此时需要在自己的setting.json进行配置。快捷键ctrl ,(逗号)打开设置Settings点击设置界面右上角的Edit as JSON进入setting.json文件你看的可能是{ }花括号中可能是空的也可能有代码。如果是空的就直接把配置复制进去如果有代码记得将上面的最后一行代码后加上逗号,然后再复制粘贴配置代码代码在后面。 实现SumatraPDF的双向跳转在代码配置完成后实现正向跳转Latex代码到PDF对应段落是比较简单的比较难实现的是方向跳转。而反向跳转又比较重要方便在预览PDF中发现错误后直接跳转到对应代码进行修改。建议可以先按照文末的JSON设置进行务必修改里面相应的路径还一定要修改正确并且里面的路径是“/”。如果此时反向跳转不成功将其中latex-workshop.view.pdf.external.synctex.args中的下面两行注释掉-inverse-search,\D:/VSCode/Microsoft VS Code/Code.exe\ \D:/VSCode/Microsoft VS Code/resources/app/out/cli.js\ -r -g \%f:%l\,// 注意修改路径最后在SumatraPDF中点击左上角的三条粗横线图标然后点击设置-选项在弹出的选项框中最下面填入D:\VSCode\Microsoft VS Code\bin\code.cmd -r -g %f:%lD:\VSCode\Microsoft VS Code记得修改为自己对应的路径。️ VS Code 关于Latex SumatraPDF 的完整配置// ----------------------- Latex Workshop ----------------------- //// 设置是否自动编译选项包括 onSave保存时自动编译、onFileChange文件更改时自动编译和 never从不自动编译latex-workshop.latex.autoBuild.run:onSave,latex-workshop.showContextMenu:true,latex-workshop.intellisense.package.enabled:true,latex-workshop.message.error.show:false,latex-workshop.message.warning.show:false,// 核心输出目录设置latex-workshop.latex.outDir:%DIR%/build,latex-workshop.latex.autoClean.run:onFailed,latex-workshop.latex.recipe.default:lastUsed,latex-workshop.view.pdf.internal.synctex.keybinding:double-click,editor.unicodeHighlight.ambiguousCharacters:false,// 要清理的垃圾文件类型latex-workshop.latex.clean.fileTypes:[*.aux,*.bbl,*.blg,*.idx,*.ind,*.lof,*.lot,*.out,*.toc,*.acn,*.acr,*.alg,*.glg,*.glo,*.gls,*.ist,*.fls,*.log,*.fdb_latexmk],// 编译器工具配置必须每个都加上 output-directory 参数latex-workshop.latex.tools:[{name:xelatex,command:xelatex,args:[-synctex1,-interactionnonstopmode,-file-line-error,-output-directory%OUTDIR%,%DOC%]},{name:pdflatex,command:pdflatex,args:[-synctex1,-interactionnonstopmode,-file-line-error,-output-directory%OUTDIR%,%DOC%]},{name:latexmk,command:latexmk,args:[-synctex1,-interactionnonstopmode,-file-line-error,-xelatex,-outdir%OUTDIR%,%DOCFILE%]},{name:bibtex,command:bibtex,args:[%OUTDIR%/%DOCFILE%]}],// 专门让 LaTeX 文件自动换行[latex]:{editor.wordWrap:on},// 编译配方组合latex-workshop.latex.recipes:[{name:XeLaTeX,tools:[xelatex]},{name:xelatex - bibtex - xelatex*2,tools:[xelatex,bibtex,xelatex,xelatex]},{name:PDFLaTeX,tools:[pdflatex]},{name:pdflatex - bibtex - pdflatex*2,tools:[pdflatex,bibtex,pdflatex,pdflatex]},{name:LaTeXmk,tools:[latexmk]}],// ----------------------- End of Latex Workshop ----------------------- //// ------------------ 使用 SumatraPDF 预览编译好的PDF文件 ---------------- //// 设置VScode内部查看生成的pdf文件// tab使用vscode内置pdf查看器browser使用系统默认浏览器external使用外部pdf查看器none不打开pdf文件latex-workshop.view.pdf.viewer:external,// 设置编译后是否跳转到pdf的对应位置latex-workshop.synctex.afterBuild.enabled:true,// PDF查看器用于在\ref上的[View on PDF]链接latex-workshop.view.pdf.ref.viewer:auto,// 使用外部查看器时要执行的命令。此功能不受官方支持。latex-workshop.view.pdf.external.viewer.command:D:/SumatraPDF/SumatraPDF.exe,// 注意修改路径// 使用外部查看器时latex-workshop.view.pdf.external.view .command的参数。此功能不受官方支持。%PDF%是用于生成PDF文件的绝对路径的占位符。latex-workshop.view.pdf.external.viewer.args:[-forward-search,%TEX%,%LINE%,-reuse-instance,%PDF%],// 将synctex转发到外部查看器时要执行的命令。此功能不受官方支持。latex-workshop.view.pdf.external.synctex.command:D:/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,-inverse-search,\D:/VSCode/Microsoft VS Code/Code.exe\ \D:/VSCode/Microsoft VS Code/resources/app/out/cli.js\ -r -g \%f:%l\,// 注意修改路径%PDF%]// ------------------ End of SumatraPDF 预览设置 ---------------- //