详解VScode 配置为 LaTeX 编辑器(IDE)

vscode 配置为 latex ide

在windows中，配置vscode作为latex的编辑器(ide)，并使用sumatrapdf预览pdf文件。主要是latex workshop扩展的设置，如果要使用外部的pdf阅读器，则还需要设置sumatrapdf。

安装扩展

ctrl+shift+x调出应用商店，搜索并安装latex workshop扩展：

配置latex workshop

latex文件.tex的编译、预览、辅助文件的清理等都在扩展latex workshop中设置。

latex workshop中，编译latex文件时顺序执行的一系列/组命令称为latex食谱(recipes)，定义在latex-workshop.latex.recipes。缺省情况，latex workshop包含2个基本的食谱，分别由latex-workshop.latex.recipes和latex-workshop.latex.tools定义。第一个食谱的tools域中的工具定义在第二个食谱。latex workshop的参数含义见latex workshop的配置文件"package.json"或https://github.com/james-yu/latex-workshop/wiki/compile#latex-recipes了解配置情况。

latex workshop默认的编译方式为latexmk和pdflatex。如下配置修改了latex workshop的编译方式、预览、辅助文件等。特别添加了xelatex及包含bib时的编译。

ctrl+shift+p ->settings->首选项：打开用户设置(json)，在settings.json中添加如下内容：

"latex-workshop.showcontextmenu":true,        //右键菜单
"latex-workshop.intellisense.package.enabled": true, //根据加载的包，自动完成命令或包 
"latex-workshop.latex.autobuild.run": "never",    //禁止保存文件时自动build 
"latex-workshop.latex.recipes": [ 
 { 
  "name": "latexmk", 
  "tools": [ 
   "latexmk" 
  ] 
 }, 
 { 
  "name": "pdflatex", 
  "tools": [ 
   "pdflatex" 
  ] 
 }, 
 { 
  "name": "pdflatex ->žž bibtex ->žž pdflatex2", 
  "tools": [ 
   "pdflatex", 
   "bibtex", 
   "pdflatex", 
   "pdflatex" 
  ] 
 }, 
 { 
  "name": "xelatex", 
  "tools": [ 
   "xelatex" 
  ] 
 }, 
 { 
  "name": "xelatex -> bibtex -> xelatex", 
  "tools": [ 
   "xelatex", 
   "bibtex", 
   "xelatex", 
  ] 
 } 
], 
"latex-workshop.latex.tools":[ 
 { 
  "name": "latexmk", 
  "command": "latexmk", 
  "args": [ 
   "-synctex=1", 
   "-interaction=nonstopmode", 
   "-file-line-error", 
   "-pdf", 
   "-outdir=%outdir%", 
   "%doc%" 
  ], 
  "env": {} 
  }, 
  { 
  "name": "pdflatex", 
  "command": "pdflatex", 
  "args": [ 
   "-synctex=1", 
   "-interaction=nonstopmode", 
   "-file-line-error", 
   "%doc%" 
  ], 
  "env": {} 
  }, 
  { 
  "name": "xelatex", 
  "command": "xelatex", 
  "args": [ 
   "-synctex=1", 
   "-interaction=nonstopmode", 
   "-file-line-error", 
   "%doc%" 
  ], 
  "env": {} 
  }, 
  { 
  "name": "bibtex", 
  "command": "bibtex", 
  "args": [ 
   "%docfile%" 
  ], 
  "env": {} 
  } 
], 
"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", 
 "*.nav", 
 "*.snm", 
 "*.synctex.gz" 
], 
"latex-workshop.view.pdf.viewer":"tab",  //pdf文件的预览方式

快捷键

打开键盘快捷方式面板(左下侧齿轮，或快捷键ctrl+k,ctrl+s)：

• 搜索"切换侧栏可见性"，设置快捷键为ctrl+k ctrl+b。
• 搜索 latex build，将默认的ctrl+alt+b替换为ctrl+b(与sublime text 3统一)。
• 搜索latex recipe，设置快捷键为ctlr+r，方便点菜(选择编译方式)！(st3中是显示文档大纲)。

其他常用的快捷键：

• ctrl+k ctrl+a： 切换活动栏可见性(左侧图标开关)
• ctrl+alt+x：显示latex面板(左侧编译命令面板和文档大纲)。
• ctrl+alt+c：清除辅助文件
• ctrl+alt+v：查看编译的pdf文件(预览)
• ctrl+alt+j：正向搜索。当设置"latex-workshop.view.pdf.viewer": "tab";时，在latex源文件中按下快捷键，定位到pdf文档相应位置。(反向搜索见后面)

一些快捷处理

根据latex-workshop.latex.recipes中的name段设定，可在.tex文件首行指定编译方式。如%!tex program = xelatex表示用xelatex编译文件，而%!tex program = pdflatex表示用latexpdf编译文件。多个文件情况，还可以用% !tex root指定主文件，% !tex bib指定bib的编译方式。

示例

%! tex program = pdflatex
\documentclass{article}

\begin{document}
  press ctrl+b to complie，press ctrl+alt+v to view pdf
\end{document}

设置latex文件和pdf文件之间的正/反向搜索

正向搜索是指按某种方式操作源文件中的部分，会在pdf文件中立即到达对应的部分。反向搜索就是在pdf文档的正文中某个位置点击，光标会定位到源文件的相应位置。正反向搜索十分方便文档错误的修改。反向搜索需要用到sumatrapdf软件(或zathura)。

sumatrapdf软件是一款小巧强悍的pdf阅读器，是免费开源软件。国内有多个pdf阅读器基于sumatrapdf修改而来。

sumatrapdf官方下载地址：

根据自己电脑操作系统，选择相应的软件下载并安装。

下面操作的一些说明：

我的vscode文件位置：vscode.exe在d:/programfiles/coding/vscode文件夹

扩展安装在d:/programfiles/coding/vscode/.vscode/。即将默认的%userprofile%\.vscode和%appdata%\code转移到了d:/programfiles/coding/vscode文件夹中，然后建立了联接：

• mklink /j "%userprofile%\.vscode" ".vscode"
• mklink /j ""%appdata%\code"" "code"

将sumatrapdf.exe复制到d:/programfiles/coding/vscode/.vscode/，后面的设置只是针对这个位置的sumatrapdf.exe，设置不会影响其他位置的sumatrapdf.exe。因为我有时会使用sumblime text3，默认的sumatrapdf.exe已经对其设置。

使用下面的设置，需要修改其中的vscode.exe、cli.js、sumatrapdf.exe这三个文件的路径为自己电脑对应的路径。
步骤如下：

打开设置文件settings.json，添加如下设置(注意查找重复的配置项，如前面的配置中最后一行有latex-workshop.view.pdf.viewer，用下面的替换)：

// 设置预览方式
"latex-workshop.view.pdf.viewer":"external",
"latex-workshop.view.pdf.ref.viewer":"external",
// 设置外部pdf预览器
"latex-workshop.view.pdf.external.viewer.command": "d:/programfiles/coding/vscode/.vscode/sumatrapdf.exe",
"latex-workshop.view.pdf.external.viewer.args": [
  "%pdf%"
],
// 配置syntex的正向搜索(这是官网的)
"latex-workshop.view.pdf.external.synctex.command": "d:/programfiles/coding/vscode/.vscode/sumatrapdf.exe",
"latex-workshop.view.pdf.external.synctex.args": [
  "-forward-search",
  "%tex%",
  "%line%",
  "-reuse-instance",
  "-inverse-search",
  "d:/programfiles/coding/vscode/code.exe d:/programfiles/coding/vscode/resources/app/out/cli.js -r -g %f:%l",
  "%pdf%"
],

配置反向搜索（pdf->latex源文件）

反向搜索在sumatrapdf中设置。打开sumatrapdf，进入设置->选项 对话框，在“设置反向搜索命令行”处填入如下内容(是一行内容，不是2行！)：

"d:\programfiles\coding\vscode\code.exe"

"d:\programfiles\coding\vscode\resources\app\out\cli.js" -r -g "%f:%l"

双击pdf中的任意一处即可跳转到vscode中所对应的内容的源代码处

反向搜索的使用：打开一个已经编译的tex文件，ctrl+alt+v打开pdf文件。在pdf文件中的某行文字处，双击鼠标左键，会切换到了源文件的相应位置。如果点击的是公式、图等，可能不会正确返回。

正向搜索的使用：将光标移动到tex文件的正文。ctrl+alt+x，找到"navigator,select and edit"，点击第一项"synctex from cursor"(或右键选择，或快捷键ctrl+alt+j )，会切换到pdf文件的相应位置。

如果不成功，检查路径设置，或者文件名错误。正反向搜索用到了.synctex.gz文件，不能删除。

参考文章

viewing & synctex

使用vscode编写latex

最后的设置(sumatrapdf预览+正反搜索)

  "latex-workshop.showcontextmenu":true,
  "latex-workshop.intellisense.package.enabled": true, //根据加载的包，自动完成命令或包
  "latex-workshop.latex.autobuild.run": "never",    //禁止保存文件时自动build
  "latex-workshop.latex.recipes": [
   {
    "name": "latexmk",
    "tools": [
     "latexmk"
    ]
   },
   {
    "name": "pdflatex",
    "tools": [
     "pdflatex"
    ]
   },
   {
    "name": "pdflatex ->žž bibtex ->žž pdflatex2",
    "tools": [
     "pdflatex",
     "bibtex",
     "pdflatex",
     "pdflatex"
    ]
   },
   {
    "name": "xelatex",
    "tools": [
     "xelatex"
    ]
   },
   {
    "name": "xelatex -> bibtex -> xelatex*2",
    "tools": [
     "xelatex",
     "bibtex",
     "xelatex",
     "xelatex"
    ]
   }
  ],
  "latex-workshop.latex.tools":[
   {
    "name": "latexmk",
    "command": "latexmk",
    "args": [
     "-synctex=1",
     "-interaction=nonstopmode",
     "-file-line-error",
     "-pdf",
     "-outdir=%outdir%",
     "%doc%"
    ],
    "env": {}
    },
    {
    "name": "pdflatex",
    "command": "pdflatex",
    "args": [
     "-synctex=1",
     "-interaction=nonstopmode",
     "-file-line-error",
     "%doc%"
    ],
    "env": {}
    },
    {
    "name": "xelatex",
    "command": "xelatex",
    "args": [
     "-synctex=1",
     "-interaction=nonstopmode",
     "-file-line-error",
     "%doc%"
    ],
    "env": {}
    },
    {
    "name": "bibtex",
    "command": "bibtex",
    "args": [
     "%docfile%"
    ],
    "env": {}
    }
  ],
  //"latex-workshop.latex.autoclean.run": "onbuilt",
  "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",
   "*.nav",
   "*.snm",
   "*.synctex.gz",
   "*.bcf",
   "*.run.xml"
  ],
  "latex-workshop.view.pdf.viewer":"external",
  "latex-workshop.view.pdf.ref.viewer":"external",
  // 设置外部pdf预览器
  "latex-workshop.view.pdf.external.viewer.command": "d:/programfiles/coding/vscode/.vscode/sumatrapdf.exe",
  "latex-workshop.view.pdf.external.viewer.args": [
    "%pdf%"
  ],
  // 配置syntex的正向搜索(latex->pdf)
  "latex-workshop.view.pdf.external.synctex.command": "d:/programfiles/coding/vscode/.vscode/sumatrapdf.exe",
  "latex-workshop.view.pdf.external.synctex.args": [
   "-forward-search",
   "%tex%",
   "%line%",
   "-reuse-instance",
   "-inverse-search",
   "d:/programfiles/coding/vscode/code d:/programfiles/coding/vscode/resources/app/out/cli.js -r -g %f:%l",
   "%pdf%"
  ],

到此这篇关于详解vscode 配置为 latex 编辑器(ide)的文章就介绍到这了,更多相关vscode latex编辑器内容请搜索以前的文章或继续浏览下面的相关文章希望大家以后多多支持！