くらげnote

"ぼやき" by くらげ(fal)

Windows × VSCode で構築する快適なLaTeX環境

VSCode LaTeX

この記事を読んでできること

  • .tex ファイルから .pdf ファイルを（ショートカットキーで）自動生成する
    • ただし, upLaTeX を用いているものとする
  • 複数回ビルドが必要な場合もショートカットキーは1度押せばできる
  • 不要な中間ファイルも削除する

1 必要なもの

  1. TeX Live 20xx のインストール
    （参考: TeX Live - TeX Wiki ）
  2. VSCode のインストール
    （ダウンロード先: Visual Studio Code – コード エディター | Microsoft Azure ）
  3. （あった方がいい） SumatraPDF のインストール
    （ダウンロード先: Free PDF Reader - Sumatra PDF ）

2 (up)LaTeX を使うための VSCode

VSCodeを起動し、 Ctrl + Shift + X で拡張機能ウィンドウを開ける

  1. LaTeX Workshop をインストール
  2. LaTeX language support をインストール
  3. Japanese Language Pack for Visual Studio Code をインストール
    • 日本語化する必要がなければ不要
  4. （お好みで）Bracekt Pair Colorizer 2をインストール
    • 対応する括弧に色付けを行う
    • LaTeX Workshop と相性が悪いらしいが,今のところ不具合はない

インストールしなくても, 標準機能に組み込まれるようになりました.

    "editor.guides.bracketPairs": true,
    "editor.bracketPairColorization.enabled": true,

をsetting.jsonに書き込めば十分です. 参考 : メンテナンスされなくなった Bracket Pair Colorizer 2 から VS Code に標準搭載の括弧記号色付け機能に乗り換えよう | DevelopersIO

3 VSCode の設定（ビルド関係）

upLaTeX を用いることとします.

  • Ctrl + , で設定を開く

  • 右上の「設定(JSON)を開く」を選択

  • setting.json に以下を記述。
    もし既になにか書き込んである場合は、下に追加すれば良い

 "latex-workshop.chktex.enabled": false,
 "latex-workshop.latex.autoBuild.run": "never",
 "latex-workshop.latex.outDir": "%DIR%",

 // build commands
 "latex-workshop.latex.tools": [
   {
     "name": "Latexmk (upLaTeX)",
     "command": "latexmk",
     "args": [
       "-f",
       "-gg",
       "-pv",
       "-synctex=1",
       "-interaction=nonstopmode",
       "-file-line-error",
       "%DOC%"
     ]
   },
 ],
 // to build .tex file written in LaTeX(upLaTeX)
 // using .Latexmk 
 "latex-workshop.latex.recipes": [
   {
     "name": "upLaTeX",
     "tools": ["Latexmk (upLaTeX)"]
   },
 ],
 
 // delete intermediate files every building
 "latex-workshop.latex.autoClean.run": "onBuilt",
  // select intermediate files which are deleted
 "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",
    "*.dvi","*.synctex.gz","*.nav",
    "*.snm","*.vrb","*.pl", ".000"
  ],

4 VSCodeの設定 （キーボードショートカットの編集）

必須ではないが、作業効率を上げることができる

  • Ctrl+K Ctrl+S でキーボードショートカットを開く
    • （私自身が最初、引っかかったので念の為）
      Ctrl+K Ctrl+Sは
      「Ctrlを（ずっと）押しながら K 押す→K離す→S押す→S離す」
      を行えば良い
    • 左上の「ファイル>ユーザー設定>キーボードショートカット」でも開ける
  • ビルドするショートカットキーを LaTeX Workshop: Build LaTeX project に設定
    • Ctrl + Shift + B, Ctrl + Alt + B,Ctrl + Shift + Alt + B あたりだと衝突もしないのでおすすめ
  • LaTeX Workshop: Build with recipe だとレシピの選択もできる
    • 複数のレシピを使い分ける必要がある場合はおすすめ
  • PDFファイルを表示するショートカットキーを LaTeX Workshop: View LaTeX PDF file に設定
    • Ctrl + Alt + V がおすすめ

5 .latexmrc ファイルの作成

VSCode で LaTeX を書く (2018) - Qiita を参照ください.

参考記事がなくなると（私が）困るので、必要なところを引用すると

以下の内容をコピーして、現在のユーザーのホームディレクトリに .latexmkrc として保存してください。
なお、Windows の場合はファイル名がピリオド (.) で始まるファイルを作成する場合は、 [ファイル名].とする必要があるため、.latexmkrc.というファイル名でファイルを保存するようにしてください。

latexmkrc ファイルの中身を全て引用するのはやりすぎな気がするので、必要な方は参考記事VSCode で LaTeX を書く (2018) - Qiita（再掲）を確認ください.

蛇足として、ホームディレクトリは通常C:\Users\<ユーザ名>とすればよい.

細かいことの書いてある参考記事はこちら. Latexmk - TeX Wiki

6 テストしてみる

\documentclass[dvipdfmx, uplatex]{jsarticle}
\usepackage{amsmath}
\begin{document}
これは\LaTeX を用いて書かれています.

平均値の定理:
$f(x)$ が $[a, b]$ で連続, $(a, b)$ で微分可能のとき, 
\begin{align*} 
  \frac{f(b)-f(a)}{b-a}=f^{\prime}(c),\, a<c<b
\end{align*}
を満たす$c$が存在.
\end{document}

更新履歴

211211 upLaTeX であることを明記, #6 テストの部分を追加, Bracekt Pair Colorizer 2に関する記述を更新