本博客主要介紹如何在Visual Studio Code (VS Code)上配置LaTeX的編寫環境,主要包括如下幾個軟件/工具的安裝配置以及正反向搜索的配置:
- TeX Live
- VS Code(含插件)
- SumatraPDF
1. TeX Live
在這裏我們採用在線安裝的方式安裝TeX Live,具體執行步驟如下:
- 在TeX Live下載界面選擇適合自己操作系統的安裝軟件,這邊選擇windows的安裝文件,如下圖所示:
- 以管理員身份運行所下載的文件,如下圖所示:
- 在所彈出的界面中選擇Install選項,隨後點擊Next按鈕,並在新彈出的界面點擊Install,如下圖所示:
- 這時候就會進入到真正的安裝界面,這邊可以根據個人需要選擇TeX Live的安裝路徑以及一些設置一些更高級的選項,如具體選擇需要安裝的包。在這裏我們只改變TeX Live的安裝路徑,其它選項按默認配置,如下圖所示:
- 接下來就會從網上下載所需要的的文件,這個過程會比較漫長,如下圖所示:
- 當下載完成後,就會顯示如下界面,至此TeX Live安裝完成。
2. VS Code(含插件)
2.1 VS Code安裝
VS Code的具體安裝步驟如下所示:
- 首先,到VS Code下載界面下載相應操作系統的安裝文件,如下圖所示:
- 點擊所下載的可執行文件,根據個人需求逐步安裝,在這裏我們只更改了安裝路徑,其餘選項按默認配置,如下圖所示:
- 最後會顯示如下界面,至此VS Code安裝完成。
2.2 LaTeX Workshop 插件安裝
在安裝完VS Code之後還不能編寫LaTeX代碼,此時就需要安裝必要的插件LaTeX Workshop,具體執行步驟如下所示:
- 在VS Code主界面上,點擊左側菜單欄中的Extensions,如下圖所示:
- 在彈出的搜索欄中輸入LaTeX Workshop,選擇正確的插件,如下圖所示:
- 在彈出的界面上,點擊Install按鈕,如下圖所示:
- 至此LaTeX Workshop插件安裝成功,如下圖所示:
2.3 VS Code參數配置
VS Code參數配置是整個環境配置相對比較複雜的部分,包含了。。。配置,具體步驟如下:
- 在VS Code主界面同時按下ctrl + Shift + p,會在主界面上方出現一個搜索框,在該搜索框中輸入setting,選擇下方的Preferences: Open Settings (JSON),進入到VS Code的參數配置界面,這邊是以JSON的方式進行設置的。如下圖所示:
- 隨後,在該文件中配置如下內容:
{
"latex-workshop.latex.recipes": [
{
"name": "pdflatex->bibtex->pdflatex*2",
"tools": [
"pdflatex",
"bibtex",
"pdflatex",
"pdflatex"
]
},
{
"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",
"%DOC%"
]
},
{
"name": "xelatex",
"command": "xelatex",
"args": [
"-synctex=1",
"-interaction=nonstopmode",
"-file-line-error",
"%DOC%"
]
},
{
"name": "pdflatex",
"command": "pdflatex",
"args": [
"-synctex=1",
"-interaction=nonstopmode",
"-file-line-error",
"%DOC%"
]
},
{
"name": "bibtex",
"command": "bibtex",
"args": [
"%DOCFILE%"
]
}
],
"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"
],
}
在"latex-workshop.latex.recipes":中,第一個配置爲默認的編譯順序,在這邊我們設置爲pdflatex -> bibtex -> pdflatex*2,該配置適用於英文期刊模板等。第二個配置爲網上其它教程通常使用的默認配置,如果平時進行的大部分都是英文期刊寫作,不建議將這個作爲默認配置。
如果不使用默認配置的話,可以點擊VS Code主界面左下角的小勾,在彈出的界面下拉Build LaTeX project,就可以選擇其它配置方案,具體如下圖所示:
注意,每次修改完配置文件,都要重啓VS Code才能生效。
3. SumatraPDF
3.1 SumatraPDF安裝
SumatraPDF的具體安裝步驟如下所示:
- 首先,在SumatraPDF下載界面中,根據操作系統的不同下載所需的安裝文件,如下圖所示:
- 點擊所下載的可執行文件安裝SumatraPDF,如下圖所示:
- 至此,SumatraPDF安裝完成,如下圖所示:
3.2 正反向搜索配置
在下載安裝完所有需要的軟件後,需要配置的就是常用的正反向搜索,分爲在VS Code配置正向搜索和在SumatraPDF上配置反向搜索,具體執行步驟如下所示:
3.2.1 正向搜索
使用2.3節所介紹的方法打開VS Code的配置文件,在第一對大括號{}裏的最後面加入如下內容:
"latex-workshop.view.pdf.viewer": "external",
"latex-workshop.view.pdf.external.viewer.command": "D:/Program Files (x86)/SumatraPDF/SumatraPDF.exe",
"latex-workshop.view.pdf.external.viewer.args": [
"--unique",
"%PDF%"
],
"latex-workshop.view.pdf.external.synctex.command": "D:/Program Files (x86)/SumatraPDF/SumatraPDF.exe",
"latex-workshop.view.pdf.external.synctex.args": [
"-forward-search",
"%TEX%",
"%LINE%",
"-reuse-instance",
"-inverse-search",
"code \"D:\\Program Files (x86)\\Microsoft VS Code\\resources\\app\\out\\cli.js\" -r -g \"%f:%l\"",
"%PDF%"
],
注意將上述配置中關於VS Code和SumatraPDF的安裝路徑替換成自己的安裝路徑。此外,“latex-workshop.view.pdf.viewer”: "external"表示使用外部pdf閱讀器預覽生成的pdf文件,如果要使用VS Code自帶的預覽器,可以將external替換成tab。
3.2.2 反向搜索
在SumatraPDF配置反向搜索主要包含如下幾個步驟:
- 打開以安裝完成的SumatraPDF,在主界面點擊菜單按鈕->設置->高級選項,如下圖所示:
- 隨後在打開的文件中找到EnableTeXEnhancements選項,將其設置爲True並保存,如下圖所示:
- 返回主界面,點擊菜單按鈕->設置->選項,如下圖所示:
- 在彈出的界面的最下方,輸入如下命令,如下圖所示:
"D:\Program Files (x86)\Microsoft VS Code\Code.exe" "D:\Program Files (x86)\Microsoft VS Code\resources\app\out\cli.js" -r -g "%f:%l"
注意將上述VS Code的路徑替換成自己的安裝路徑;此外,不能清理運行所產生的.gz格式文件,否則不能進行正反向搜索。
至此,基於VS Code的LaTeX基礎環境配置完畢。
示例
本節展示在VS Code編寫並編譯TeX代碼,並執行正反向搜索。
- 在VS Code主界面上打開本地文件夾,這邊打開C盤下的test文件夾,如下圖所示:
- 新建一個.tex格式的文件test.tex,如下圖所示:
- 打開test.tex,並輸入以下內容,如下圖所示:
\documentclass{article}
\begin{document}
hello world
\end{document}
- 同時按下Crtl + Alt + B進行編譯,左下方會顯示如下圖所示的編譯狀態, 在這邊一共需要經歷pdflatex->bibtex->pdflatex->pdflatex四個狀態。
- 在編譯完成後,同時按下Crtl + Alt + V預覽所生成的pdf文件。
- 正向搜索方法:將光標至於.tex文件需要搜索的位置,同時按下Crtl + Alt + J,會在pdf中高亮對應位置的上下文,如下圖所示:
- 反向搜索方法:直接在pdf中雙擊需要反向查找的地方,既可定位到.tex文件中的對應位置。
其它配置
本節收錄其它相關配置:
- LaTeX Workshop插件會默認在保存的時候自動編譯,如果不喜歡這個配置,可以在VS Code的配置文件中添加如下代碼:
"latex-workshop.latex.autoBuild.run": "never",
- 如果想要編寫中文文檔,可以在.tex文件的合適位置上輸入以下命令
\usepackage[UTF8]{ctex}
- 如果安裝路徑包含中文字符的話,可以將"latex-workshop.latex.tools":中的%DOC%更改爲%DOCFILE%。