macOS 配置 LaTeX ( MacTeX + VScode + Skim )

macOS + VScode + LaTeX (环境配置)

前几天想学用 LaTeX 写文章,发现 LaTeX 自带的编辑器和 Subline Text 外观的自由度不大,于是就想到了拥有丰富主题的 VScode 。

但网上对于 macOS 上 VScode 的 LaTeX 配置教程很少,而且都比较零散,也没有很好的解决我在配置中遇到的种种问题。所以我就把我的配置过程和配置中用到的资源整理一下,看看能不能帮到你叭。

1. 安装 MacTeX

MacTeX 是 TeX Live 的 Mac 版本

MacTeX 是 LaTeX 的基础运行环境,提供 LaTeX 的编译器和内置命令 TeX bin 等。关于MacTeX的安装,这里使用 tug(TeX User Group) 提供的安装包。因为安装包较大,而且这是个国外网站,下载过程要持续十到二十分钟,耐心等等就好。Click to Download

下载完成后,打开Terminal,键入“ latex -version“ 查看是否安装成功。若安装成功,终端显示 LaTeX 的版本信息(如下图);


安装成功.png

若提示 “ zsh: command latex not found ” 可能是 TeX 命令添加不成功,试试手动添加。找到 MacTeX 的安装路径,并在该路径下找到 “ TeX bin ” 文件夹,拷贝该文件夹的绝对路径,添加到环境变量和系统变量中即可(使用 nano 或 vim)。

添加成功后,在终端使用 ” env ” 查看 PATH 中是否已经有 TeX bin 命令。


添加成功.png

2. 安装 CTAN 的 Images 镜像

如果第一步已经下载成功,就不用再使用镜像加速下载了

如果 tug 下载速度太慢,可尝试使用镜像加速下载。我使用的是重庆大学的开源镜像网站,目录为 “ Index of / CTAN / systems / texlive / Images / ”。进入后下载该目录下大小为 4G 的第一个 texlive.iso。Click to go to Images

CTAN Images

3. 下载 Skim 阅读器

Skim 阅读器是一个支持 macOS 系统的嵌入式轻量级 PDF 阅读器,相当于 Windows 下的 Sumatra 阅读器

LaTeX 支持使用外部阅读器浏览 PDF 文件。使用外部自定义的 PDF 阅读可以带来更好的阅读体验,而且可以实现在 VScode 中的分屏,实时浏览文章的排版和效果,非常方便。

如果在 Skim 官网 下载速度较慢,可以试试在 SoftonicSourceForge 上下载。

4. 在 VScode 中下载 LaTeX Workshop 插件

LaTeX Workshop 是 VScode 中支持 LaTeX 语言的插件,提供 LaTeX 文件的编译、项目的创建、排版的浏览等功能

在 VScode 的 Extension 中搜索 LaTeX Workshop 进行安装。


LaTeX Workshop.png

安装成功后,在工作区下方的状态栏中会出现一个小对勾(或小叉号),点击打开就可以进入 LaTeX 的工作台。


工作台.jpeg

5. 配置 LaTeX Workshop 的 Settings JSON 文件

安装完成后,需要配置工作区的编译工具,编译命令,自动编译等才可以正常使用。

(1)使用 “ command + shift + P ” 打开命令行


命令行.png

(2)键入 “ Open Settings(JSON)” 打开JSON配置文件,将如下代码添加进配置。添加就好,一定不要覆盖!

    // LaTeX
    // 不在保存的时候自动编译
    "latex-workshop.latex.autoBuild.run": "never",
    // 编译工具
    "latex-workshop.latex.tools": [
        {
            "name": "xelatex",
            "command": "xelatex",
            "args": [
                "-synctex=1",
                "-interaction=nonstopmode",
                "-file-line-error",
                "-pdf",
                "%DOCFILE%"
            ]
        },
        {
            "name": "pdflatex",
            "command": "pdflatex",
            "args": [
                "-synctex=1",
                "-interaction=nonstopmode",
                "-file-line-error",
                "%DOCFILE%"
            ]
        },
        {
            "name": "bibtex",
            "command": "bibtex",
            "args": [
                "%DOCFILE%"
            ]
        }
    ],
  // 编译命令
    "latex-workshop.latex.recipes": [
        {
            "name": "xelatex",
            "tools": [
                "xelatex"
            ],
        },
        {
            "name": "xelatex*2",
            "tools": [
                "xelatex",
                "xelatex"
            ],
        },
        {
            "name": "pdflatex",
            "tools": [
                "pdflatex"
            ]
        },
        {
            "name": "xe->bib->xe->xe",
            "tools": [
                "xelatex",
                "bibtex",
                "xelatex",
                "xelatex"
            ]
        },
        {
            "name": "pdf->bib->pdf->pdf",
            "tools": [
                "pdflatex",
                "bibtex",
                "pdflatex",
                "pdflatex"
            ]
        }
    ],

    "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"  
    ],

    // // 使能从 VSCode跳转到 Skim 里相应位置
    // // external pdf viewer
    // "latex-workshop.view.pdf.viewer": "external",
    // "latex-workshop.view.pdf.external.synctex.command": "/usr/local/bin/displayline",
    // "latex-workshop.view.pdf.external.synctex.args": [
    //     "-r",
    //     "%LINE%",
    //     "%PDF%",
    //     "%TEX%"
    // ],

    // // 使能从 VSCode 中直接打开 Skim
    // "latex-workshop.view.pdf.external.viewer.command": "/usr/local/bin/displayline",
    // "latex-workshop.view.pdf.external.viewer.args": [
    //     "0",
    //     "%PDF%"
    // ],

5. 配置 LaTeX Workshop 的快捷键 Keybindings JSON 文件

将常用的指令添加到快捷键可以提高编辑效率,命令与对应的快捷键如下:

前向搜索:option + s
开始编译:option + b
终止编译:option + t
选择其他recipe编译:option + e

配置时同样打开命令行,键入“ Open KeyBorad Shortcuts (JSON) ” ,打开快捷键配置文件,添加如下代码:

    {
        // 前向搜索
        "key": "alt+s",
        "command": "latex-workshop.synctex",
        "when": "editorTextFocus"
    },
    {
        // 使用默认 recipe 编译
        "key": "alt+b",
        "command": "latex-workshop.build",
        "when": "editorTextFocus"
    },
    {
        // 终止编译
        "key": "alt+t",
        "command": "latex-workshop.kill",
        "when": "editorTextFocus"
    },
    {
        // 选择其他 recipe 编译
        "key": "alt+e",
        "command": "latex-workshop.recipes"
    },

6.测试

配置完成后,使用工作台新建.tex文件对环境进行测试。

(1) 先新建测试文件 test.tex 文件,复制以下测试代码:

\documentclass{article}
\usepackage[UTF8, scheme = plain]{ctex}

\begin{document}
This is a test file
\end{document}

(2) 点击小勾,打开 LaTeX 工作台,点击 “ Build Project ” 进行编译

Build.jpeg

(3) 编译成功后,点击上方状态栏右边的阅读按钮,可在工作台分屏查看代码的 PDF 文件

上方状态栏

配置成功效果图

7. 异常解决

当运行时出现 “ Recipe terminated with fatal error: spawn xelatex ENOENT ” 异常,先检查环境变量 PATH 中是否存在 TeX bin 路径,TeX bin 中存放的是与 TeX 有关的指令,若环境变量中没有该指令集,会导致 VScode 在编译时找不到指令。检查方法和 “ 1. 安装TeX ” 的检查方式相同,若不存在,则在 PATH 中添加 TeX 的指令集。

若 PATH 中存在该指令集但仍编译不成功,考虑可能是环境变量未更新。重新启动计算机,再进行编译,即可更新所有环境变量。此时再尝试编译,应该就可以成功了。

-- end --
-- Author : Dong Levine --
-- Date : 2021-07-15 --

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,240评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,328评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,182评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,121评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,135评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,093评论 1 295
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,013评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,854评论 0 273
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,295评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,513评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,678评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,398评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,989评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,636评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,801评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,657评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,558评论 2 352

推荐阅读更多精彩内容