vscode论文

在 VS Code 中实现类似 Overleaf 的体验(即左侧写代码,右侧实时预览 PDF,保存即编译),主要分为三个步骤:安装编译器(后端)、安装编辑器插件、配置自动化设置

以下是详细的保姆级教程:


第一步:安装 LaTeX 发行版(编译器)

VS Code 只是一个编辑器,它本身不懂 LaTeX,需要通过“幕后”的编译器来生成 PDF。这相当于 Overleaf 的服务器端。

根据你的操作系统选择:

  1. Windows 用户 (推荐 TeX Live 或 MiKTeX):
  • TeX Live (推荐): 安装包较大(约 4-7GB),但最全,安装后几乎不需要再折腾。
  • 下载地址:TeX Live 官网 (下载 install-tl-windows.exe)
  • MiKTeX: 轻量级,遇到缺少的宏包会自动下载。
  1. macOS 用户:
  • MacTeX: 专为 Mac 设计的 TeX Live 版本。
  1. Linux 用户:
  • 使用包管理器安装(如 sudo apt-get install texlive-full)。
注意: 安装过程可能比较慢(特别是 TeX Live),请耐心等待。安装完成后,建议重启电脑以确保环境变量生效。

第二步:配置 VS Code

  1. 安装插件:
  • 打开 VS Code。
  • 点击左侧边栏的“扩展”图标(方块状)。
  • 搜索并安装 LaTeX Workshop (作者是 James Yu)。这是目前最强大、最标准的插件。
  1. 验证环境:
  • Ctrl + Shift + P​ (Mac 是 Cmd + Shift + P) 打开命令面板。
  • 输入 LaTeX Workshop: Check System 并回车。如果右下角弹出绿色提示,说明 VS Code 成功找到了你刚才安装的 TeX 发行版。如果是红色报错,说明第一步没装好或者需要重启。

第三步:实现“Overleaf 式”的编辑体验

Overleaf 的核心体验是写代码 -> 自动编译 -> 侧边预览。我们来逐一设置。

1. 创建并编译第一个文件

  1. 新建一个文件夹,并在 VS Code 中打开它。
  2. 新建一个文件 main.tex
  3. 输入测试代码(支持中文):

   \documentclass{article}
   \usepackage[UTF8]{ctex} % 引入中文包

   \begin{document}
   Hello, VS Code!
   你好,世界!
   \end{document}
  1. 编译:
  • VS Code 默认设置下,当你按 Ctrl + S (保存) 时,插件会自动开始编译。
  • 或者点击左侧活动栏出现的“TEX”图标,在 "Commands" 里点击 Build LaTeX project

2. 开启右侧 PDF 预览

编译成功后,我们需要像 Overleaf 一样在右侧看到 PDF。

  • 方法一 (快捷键):
  • Ctrl + Alt + V​ (Mac: Cmd + Option + V)。
  • PDF 会在右侧打开,形成左代码、右预览的布局。
  • 方法二 (点击):
  • 点击编辑器右上角的一个小图标(看起来像放大镜或者书本,鼠标悬停显示 View LaTeX PDF)。

3. 配置正反向跳转 (SyncTeX)

这是比 Overleaf 网页版更丝滑的功能:

  • 代码 -> PDF (正向): 按住 Ctrl​ (Mac: Cmd) 并点击代码中的某一行,右侧 PDF 会自动滚动到对应位置并高亮。
  • PDF -> 代码 (反向): 按住 Ctrl​ (Mac: Cmd) 并点击 PDF 中的文字,左侧代码会自动跳转到对应行。

第四步:优化配置(让它更像 Overleaf)

VS Code 的默认配置已经很好,但可以通过修改 settings.json 让它更顺手。

  1. Ctrl + , 打开设置,点击右上角的“打开设置(json)”图标。
  2. 你可以添加或修改以下配置:

{
    // 1. 自动编译设置
    // "onFileChange": 文件修改后自动编译 (类似 Overleaf)
    // "onSave": 保存时编译 (推荐,避免未写完就报错)
    "latex-workshop.latex.autoBuild.run": "onSave",

    // 2. 编译出错时是否弹出窗口
    "latex-workshop.message.error.show": false,
    "latex-workshop.message.warning.show": false,

    // 3. 配置编译链 (解决中文编译问题)
    // 默认是 pdflatex,中文通常需要 xelatex
    // 如果你想让它智能识别,推荐使用 "magic comment" (见下文)
    // 或者将默认工具设为 xelatex
    "latex-workshop.latex.recipes": [
        {
            "name": "xelatex",
            "tools": [
                "xelatex"
            ]
        },
        {
            "name": "latexmk",
            "tools": [
                "latexmk"
            ]
        }
    ],
    "latex-workshop.latex.tools": [
        {
            "name": "latexmk",
            "command": "latexmk",
            "args": [
                "-synctex=1",
                "-interaction=nonstopmode",
                "-file-line-error",
                "-pdf",
                "-outdir=%OUTDIR%",
                "%DOC%"
            ]
        },
        {
            "name": "xelatex",
            "command": "xelatex",
            "args": [
                "-synctex=1",
                "-interaction=nonstopmode",
                "-file-line-error",
                "%DOC%"
            ]
        }
    ],
    
    // 4. 清理辅助文件 (编译产生的 .aux, .log 等垃圾文件)
    // 设置为 onCompile 或 onBuilt 可以在编译后自动删除
    "latex-workshop.latex.autoClean.run": "onBuilt",
}

关键技巧:处理中文编译

Overleaf 中你需要设置 Compiler 为 XeLaTeX,在 VS Code 中最简单的方法是使用 Magic Comment

在你的 .tex​ 文件的第一行加上这句注释:


%!TEX program = xelatex
\documentclass{article}
...

LaTeX Workshop 插件检测到这行代码后,会自动切换使用 xelatex 编译器,这样中文就能完美显示了,无需去改复杂的 JSON 配置。


进阶:版本控制 (替代 Overleaf 的 History)

Overleaf 的一个卖点是“历史记录”。在本地 VS Code 中,我们使用 Git 来替代。

  1. 在 VS Code 左侧点击“源代码管理”图标。
  2. 点击“初始化仓库”。
  3. 每次完成一个阶段的写作,点击“提交 (Commit)”。
  4. 你可以安装 GitLens 插件,它能让你看到每一行代码是谁在什么时候写的,甚至比 Overleaf 的历史记录更强大。

总结

  1. 安装 TeX Live (后端)。
  2. 安装 VS Code + LaTeX Workshop 插件。
  3. 文件首行加 %!TEX program = xelatex
  4. 写完按 Ctrl+S​ 保存即编译,Ctrl+Alt+V 开预览。

这样你就拥有了一个免费、无网速限制、插件丰富且支持深色模式的本地“Overleaf”了。