🖋️

VSCodeでのLaTeXの環境構築

2023/02/19に公開

論文を執筆する上で必須と言っても過言ではないLaTeX環境.
Overleafで書く人,標準のエディターで各人など好みはあると思いますが,ここではVSCodeでの環境を紹介したいと思います.
WindowsとMacはTexのインストール手段以外は同じでok

VSCodeのインストール(すでに入っている人はこの項目はスキップ)

1. インストーラのダウンロード

公式サイトからVSCodeをダウンロードします.

2. インストーラの実行

特にこだわりがなければ「次へ」ボタンを押してインストールします.

TeXLiveのインストール (for Windows)

WindowsにTexLiveをインストールする方法はいくつかあるようですが,推奨されているISOイメージをダウンロードする方法を用います.

1. インストーラのダウンロード

[ここ]9http://www.tug.org/texlive/acquire-iso.html)の「download from a nearby CTAN mirror」からtexlive20●●をダウンロードします.
こだわりがなければ最新のバージョンをダウンロードすればいいと思います.

2. インストーラの実行

こんな感じでDVDドライブとしてマウントされるので「install-tl-windows.bat」を開きます.


特にこだわりがなければ「インストール」ボタンを押してインストールを進める.


こんな感じでインストールされます.
デフォルトだと4151個もインストールされるらしいです.

そんなこんなで僕のノートでは2時間かかりました.「閉じる」を押してインストールは完了です.

TeXLiveのインストール (for Mac)

ここではHomebrewを用いてMacTeXをインストールする方法を紹介します.

1. Homebrewのダウンロード

すでに入っている人はスキップしてください
公式ページのコマンドをTerminalで実行するだけ

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

2. MacTeXのインストール

brew install mactex --cask

3. TeXLiveを最新版に更新

TeX関連のコマンドであるtlmgrを使用するので,これが使えるようにPathを通します.

sudo /usr/local/texlive/2022/bin/universal-darwin/tlmgr path add

tlmgrが使えるようになったら以下のコマンドを叩いてTeXLiveを更新

sudo tlmgr update --self --all

VSCodeの設定(Win Mac共通)

1. 拡張機能のインストール

VSCodeの拡張機能である「[* LaTeX Workshop]」をインストールします.

2. setting.jsonの編集

画像のように歯車マーク→settingをクリックするか,Ctrl + ,(Windows), + ,(Mac)でsetting.jsonを開きます.


setting.jsonに次の設定を追加します.

  • TeXは実行のたびにいっぱいファイルが作成されるのでlatex-workshop.latex.clean.fileTypesでいらない拡張子を指定することで自動で削除(推奨).
  • ビルドレシピはbibTeXの有無だけで十分だと思います.
  • ビルドツールはレシピに使うパーツなので,もしレシピを増やす場合は適宜追加する.
{
    // LaTeX 
    "latex-workshop.intellisense.package.enabled": true,
    //補助配流を自動的に削除
    "latex-workshop.latex.autoClean.run": "onBuilt",
    //削除する補助ファイルを追加
    "latex-workshop.latex.clean.fileTypes": [
        // "*.aux",
        "*.blg",
        "*.idx",
        "*.ind",
        "*.lof",
        "*.lot",
        "*.out",
        "*.toc",
        "*.acn",
        "*.acr",
        "*.alg",
        "*.glg",
        "*.glo",
        "*.gls",
        "*.ist",
        "*.fls",
        "*.log",
        "*.fdb_latexmk",
        "*.snm",
        "*.nav",
        "*.dvi",
        "*.synctex.gz"
    ],
    
    //latexmkのビルドレシピ
    "latex-workshop.latex.recipes": [
        //bibTexを使用しない場合のレシピ
        {
            "name": "ptex2pdf (uplatex)*2",
            "tools": [
                "ptex2pdf (uplatex)",
                "ptex2pdf (uplatex)"
            ]
        },
        //bibTexを使用する場合のレシピ
        {
            "name": "ptex2pdf (uplatex) -> bibtex -> ptex2pdf (uplatex) *2",
            "tools": [
                "ptex2pdf (uplatex)",
                "pbibtex",
                "ptex2pdf (uplatex)",
                "ptex2pdf (uplatex)"
            ]
        }
    ],
    
    //latexmkのビルドツール
    "latex-workshop.latex.tools": [
        {
            "name": "ptex2pdf (uplatex)",
            "command": "ptex2pdf",
            "args": [
                "-interaction=nonstopmode",
                "-l",
                "-u",
                "-ot",
                "-kanji=utf8 -synctex=1",
                "%DOC%"
            ]
        },
        {
            "name": "pbibtex",
            "command": "pbibtex",
            "args": [
                "%DOCFILE%"
            ]
        }
    ],
    
    //これより下の設定は人それぞれかも
    "latex-workshop.view.pdf.viewer": "tab",
    "latex-workshop.chktex.enabled": false,
    "latex-workshop.latex.autoBuild.run": "never",
    "editor.minimap.enabled": false,
    "window.zoomLevel": 1,
    "grammarly.files.include": [
        "**/readme.md",
        "**/README.md",
        "**/*.txt",
        "**/*.tex"
    ],
  }

3. buildのショートカットを割り当て(やらなくてもよいが推奨)

Ctrl+KCtrl+S(Win),+K+S(Mac)を押す.

検索窓に「build with recipe」と入力し,ショートカットを割り当てる.

動作確認

1. 確認用のフォルダを開く

ここでは「TEST」というフォルダを作成し開いた.

フォルダにはmain.texファイルを作る.
(内容は以下のものを引用しています)
http://www.damp.tottori-u.ac.jp/~hoshi/info/doc-info-2009/sample.tex

\documentclass[a4j,12pt]{jreport}
\title{ {\LaTeX} 動作確認テスト・サンプルファイル}
\author{情報リテラシTA}
\date{\today}
\begin{document}
\maketitle

\chapter{\LaTeX の世界にようこそ!}

\section{インストール成功!}
\LaTeX の世界にようこそ!この文章が「dviout」というソフトで閲覧できていれば、
インストールに成功しています。

\LaTeX(ラテフ)もしくは\TeX(テフ)は、
組版処理を行うソフトウェアです。
数学者・コンピュータ科学者のドナルド・クヌース氏によって作られました。

このソフトを使うと、きれいな文章の作成ができます。実際に出版の現場でも使われているそうです。
数学者が作ったということもあって、特に数式の出力がきれいにできるのが特徴です。
\begin{eqnarray}
& \displaystyle \lim _{x \rightarrow 1} \left( \frac{2}{x-1} - \frac{x+5}{x^3 -1} \right)\; ,\; 
& \displaystyle \int ^\pi _0 \cos ^2 (x)dx \nonumber
\end{eqnarray}
2つの数式が、きちんと表示されていますか?
複雑な数式が入った文章も、きれいに出力することができます。

\section{基本手順}

では、\LaTeX で文章を作る際の、基本的な手順をここに示します。

\begin{enumerate}
 \item ソースファイルをTeraPadなどのエディタで作成する。
 
 ソース(素)となるファイルを作成します。これにはエディタと呼ばれるソフトを使います。
 この地点では文章の形にはなっていません。
 
 \item ソースファイルをコンパイルして、dviファイルを作成する。
 
 パソコンに変換を命令して、先ほどつくったソースファイル
 をdviファイルに変換、文章の形にして確認します。
 
 \item dviファイルができたことを確認したら、PDFに変換する。
 
 dvi形式は、あまり一般的ではありません。
 そこで、Adobe Readerなどで閲覧ができるPDF形式に変換します。
\end{enumerate}
\end{document}

2. TeXのコンパイル]

先ほど割り当てたショートカット(Ctrl+Alt+B)からmain.texのコンパイルをします.

  • setting.jsonでレシピを2つ(bibTeXの有無)を作成したので2つの選択肢が出てきます.
  • 今回はbibTeXを使用しないので「ptex2pdf(uplatex)*2」を選択します.

    コンパイル中は画面左下に以下のようなメッセージが表示される.


成功すると✓がつきmain.pdfが作成されます.

3. pdfの表示方法

画面右上の🔍マークをクリックするとpdfが表示される.

参考にしたサイト

Discussion