VS Code配置使用 LaTeX

---

VS Code基础入门使用可查看： VS Code 基础入门使用（配置）教程
其他Vs Code 配置可关注查看： Vs Code 配置专栏

---

1. 安装插件

插件	功能
LaTeX Workshop	基本可以实现 LaTeX 需要的全部功能

2. 添加LaTeX环境变量

安装完LaTeX后，需要将LaTeX添加到环境变量中，否则 LaTeX Workshop 无法调用执行。

添加环境变量方法：
对于Windows用户：https://www.computerhope.com/issues/ch000549.htm
对于Linux用户：
https://github.com/rbenv/rbenv/wiki/unix-shell-initialization
对于macOS用户：
https://stackoverflow.com/questions/135688/setting-environment-variables-on-os-x

例如，Linux用户将texlive 安装到/home/fancy/opt/texlive/2021之后，可以在.bashrc 中添加如下文本，将LaTeX添加进环境变量中：

##--------- texlive ------------------##
PATH=$PATH:/home/fancy/opt/texlive/2021/bin/x86_64-linux

3. 格式化代码

格式化LaTeX代码需要latexindent.pl，许多LaTeX发行版已经内置了，无需单独安装。

如果使用的LaTeX没有内置，可参考此文档进行安装：https://marketplace.visualstudio.com/items?itemName=nickfode.latex-formatter

对于Linux或macOS用户，如果已经安装了latexindent.pl，但依旧报错无法格式化代码，可以依次执行：

sudo cpan Unicode::GCString
sudo cpan App::cpanminus
sudo cpan YAML::Tiny
sudo perl -MCPAN -e 'install "File::HomeDir"'

此问题可查看：https://github.com/Glavin001/atom-beautify/issues/1792

4. 查看PDF

4.1 查看编译的PDF文档

查看PDF有多重方式：

1. 查看编译的PDF，可以使用快捷键 Ctrl + Alt + V
2. 点击右上角的查看按钮
   
3. 在左侧的LaTeX环境中查看：
   

4.2 同步PDF文档与.tex文档中的位置

同步.tex文档位置到PDF

要实现上图中的PDF文档自动跳转到.tex文档中的鼠标位置处，有三种方式：

1. 使用快捷键 Ctrl + Shift + J
2. 在左侧的LaTeX环境中点击 SyncTeX from cursor
   
3. 配置自动同步跳转：在设置中（快捷键： ctrl + ,），
   将 latex-workshop.synctex.afterBuild.enabled 改为 True(打上对勾):
   
   同步PDF位置到 .tex 文档
   在右侧的PDF栏中，按住 Ctrl 键，点击鼠标左键，即可同步PDF位置到 tex 文档

5. PDF页面宽度调整

5.1 PDF自适应页面宽度

默认打开的PDF的缩放策略是 Automatic Zoom, 只会自适应打开PDF时的宽度，当我们需要自己调整代码与PDF比例的时候，PDF页面并不会跟着自适应页面宽度。如果想要实现自己调整PDF窗口比例时，PDF页面跟着自适应页面宽度，我们可以将缩放策略改为 Page Width。有两种方式：

1. PDF页面手动调整：
   我们将鼠标放到PDF视图界面的上边，会自动显示PDF菜单栏。然后将 Automatic Zoom, 改为 Page Width。
   
2. 修改默认设置：
   按快捷键Ctrl + , 打开设置，输入 latex-workshop.view.pdf.zoom, 将其值（默认auto）改为page-width。这样以后打开PDF默认都是 Page Width
   

5.2 PDF Trim

默认打开的 PDF 可能留白太多，可以在 PDF 上边点击Trim选项，修改trim比例。

如果需要每次打开都默认trim值，可以在设置中搜索latex-workshop.view.pdf.trim，修改其默认值

6. 使用预设Snippets

LaTeX Workshop 插件预设了Snippets，许多LaTeX命令可以使用以 \ 开头的代码段键入，vscode会自动提示相关的命令。此时按Tab键即可完成代码补全。

预设的Snippets可查看：https://github.com/James-Yu/LaTeX-Workshop/wiki/Snippets

一些常用的符号也放到了TeX栏中，可以使用快捷键 Ctrl + Alt + X 或者点击左侧的 Tex 栏进行查看或筛选。

也可以直接输入相关字符进行筛选：

7. 其他

注意： VS Code 中使用LaTeX，一定要确保 .tex 文件的完整路径中没有中文，否则会报错无法编译。

7.1 去除LaTeX Workshop中的警告波浪线

在设置中（快捷键：Ctrl + ,），将 latex-workshop.message.badbox.show 的对勾去掉。还是很多，觉得有点烦人的话，可以把 latex-workshop.message.warning.show 的对勾也去掉。

7.2 自动换行

按ctrl + ,打开设置面板，输入editor.wordWrap，将此选项改为on，文字到达编辑器边界就会自动换行。

7.3 关闭自动编译并设置编译快捷键

1. 关闭自动编译

按ctrl + ,打开设置面板，输入latex-workshop.latex.autoBuild.run，此选项默认为onFileChange，即当检测到文本发生改变时就编译。

我们可以将其改为onSave或者never。当改为onSave时，只会在保存文本的时候编译，如果vs code设置了自动保存，那此参数就没有了意义，需要将其改为never。

2. 自定义编译快捷键

在左侧的管理按钮，选择 Keyboard Shortcuts ，打开快捷键管理界面。

在快捷键管理界面，点击右上角的打开 快捷键 json 界面。

输入如下内容，其中 key 用来设定自定义的快捷键。

    {
        "key": "shift+enter",
        "command": "latex-workshop.recipes",
        "args": "latexmk",
        "when": "editorLangId =~ /latex|rsweave|jlweave/"
    }

设置完成后，就可以直接通过设定的快捷键 shift + enter 来编译了。

其他配置可查阅官网：

1. https://github.com/James-Yu/LaTeX-Workshop
2. https://github.com/James-Yu/LaTeX-Workshop/wiki