User Tools

Site Tools


Sidebar

latex:vscodeによるlatex環境の基本設定

概要

  • プログラミングから論文執筆まで全部一つのエディタで完結すると楽なので、VScodeでTeX環境を整えることにします。
  • VScode上でTeXファイルの作成からコンパイルとプレビューの表示まですべて行います。
  • 日本語のTeXを扱いたいので pLaTeX を使用します。英文のみであればVSCodeにLaTeX-Workshopを入れる以外は作業の必要がありません。
  • 事前に TeXLive と VSCode をインストールしてください。

設定手順

latexmkの設定

すでにlatexmkを使用されている場合は、この項目を読む必要はありません

  • latexmkはLaTeXによる一連のビルド作業を自動で行ってくれます。
  • VSCodeでは、このlatexmkを呼び出してTeXファイルをビルドします。
  • latexmkはデフォルトでpdfTeXを使用します。英語のTeXファイルであれば特に設定しなくてもPDFを作成できますが、pdfTeXは日本語に非対応なので、(u)pLaTeXやLuaTeXなど日本語環境に合わせたものに変更する必要があります。
    • ここでは日本語環境で一番メジャーなplatexとpbibtexを使用しましたが、自分の環境にあわせて適宜変更してください。

ホーム・ディレクトリ(ユーザー名がUSERNAMEの場合、Mac, Linuxの場合は /home/USERNAME/、Windowsの場合は C:\Users\USERNAME)に次の .latexmkrc というファイルを作成します。

.latexmkrc
#!/usr/bin/env perl
 
$latex = 'platex %O %S';
$bibtex = 'pbibtex %O %S';
$biber = 'biber --bblencoding=utf8 -u -U --output_safechars %O %S';
$makeindex = 'mendex %O -o %D %S';
$dvipdf = 'dvipdfmx %O -o %D %S';

VSCodeにLaTeX-Workshopを導入

  • VSCodeを開き、[View]→[Extensions](あるいはCtrl+Shift+x)から、“latex”で検索します。
  • LaTeX Workshopが一番上に表示されるはずなので、それを選んでインストールします
  • [File]→[Preferences]→[Settings]を選び(あるいは Ctrl+,)、“tools”で検索します
  • “Latex-workshop>Latex:Tools”という項目が見つかるはずなので、その下の説明文の下にある“Edit in settings.json”をクリックします。これでsettings.jsonにLateX-Workshop関係の設定が追加されます。
  • “-pdf”となっているところを“-pdfdvi”に変更します
    • platexはDVIを出力するので、dvipdfmxを使ってPDFに変換する必要があるためです。
    • pdfTeXやLuaTeXなど、直接PDFを出力するものを使いたい場合は変更不要です。
  • デフォルトではエラーが出ても(ファイルがないなど続行が原理的に不可能でない限り)コンパイルが続きます。ここでは追加で-halt-on-error(エラーが出た時点でコンパイルを強制終了)をつけておきます。

変更前

settings.json
(略)
        {
            "name": "latexmk",
            "command": "latexmk",
            "args": [
                "-synctex=1",
                "-interaction=nonstopmode",
                "-file-line-error",
                "-pdf",
                "-outdir=%OUTDIR%",
                "%DOC%"
            ],
            "env": {}
        },
(略)

変更後

settings.json
(略)
        {
            "name": "latexmk",
            "command": "latexmk",
            "args": [
                "-synctex=1",
                "-interaction=nonstopmode",
                "-file-line-error",
                "-halt-on-error",
                "-pdfdvi",
                "-outdir=%OUTDIR%",
                "%DOC%"
            ],
            "env": {}
        },
(略)

settings.json は Settings を開いて右上の書類の形をしたアイコン(カーソルを上にもっていくとOpen Settings (JSON) と表示される)をクリックすると編集できます。

使い方

  • TeXファイルは Ctrl+Alt+b でビルドできます
  • プレビューは Ctrl+Alt+v で開きます
  • プレビューをCtrlを押しながらクリックすれば、ソースコードの対応する部分に移動します
  • ソースコードで Ctrl+Alt+j とすればPDFの該当箇所に移動します

参考にしたサイト

latex/vscodeによるlatex環境の基本設定.txt · Last modified: 2021/06/27 22:04 (external edit)