🐥

LaTeX 環境の構築をしてみる

2023/04/24に公開

はじめに

今回は夏休みの課題でLaTeXの環境構築を行いました.
本課題の目的はLaTeX環境をDockerを使って構築し,ローカルの場合とgithubの場合とでmain.pdfの生成ができることを確認するまでが本課題の目的です.
自分自身LaTeXを構築することが初めてで,構築するまでの理解にかなり時間がかかりました.また自分の知らない言葉や英語での文が多かったので今回の構築で自分のスキルアップにも繋がりました.

1.WSL2(Ubuntu)

WSL2はWindows Subsystem for Linuxの略で今回LaTeXの環境構築をするために必須の互換レイヤーです.環境構築する際に必要になってくるため,まだインストールを行ってない場合は環境を構築する前にWSL2のインストールをします.

要求される環境

  1. Windows 10 ビルド 18917 以降
  2. Windows Insider Programに入っていること

WSL2の導入手順

  1. Powershell管理者として開く.
  2. wsl --installを実行するとインストールが始まる.
  3. インストールが完了したら再起動する.
  4. 再起動後自動的にUbuntuのプロンプトが起動し,Ubuntuのインストールが始まる.
  5. Ubuntuのインストールが終わるとUbuntu上で使用するユーザ名パスワードを聞かれるので入力する.※忘れないようにメモする
  6. Ubuntu上でコマンドが打てるようになれば完了.その際,先頭が $ になっている.
  7. 試しにlsb_release -aでUbuntuのバージョンが確認できるので確認してみる.

自分はターミナルを1つに収めたい派なのでWindows Terminalもインストールしました.
このソフトウェアでUbuntuのコードを直しながら他のコードもウィンドウ一つで書くことができます.
[ここから]インストールができます.

2.Docker

今回LaTeX環境構築に使用したソフトウェアはDockerというツールです.Dockerはコンテナ仮想化を用いてアプリケーションを開発・配置・実行するためのオープンプラットフォームで可搬性が高く,アーキテクチャが同じであればどの環境でも同じように動く優れたソフトウェアです.
※LaTeXの環境構築ではTeX Liveをインストールして構築する事もできますが,今回は教授が指定したドキュメントに従って構築するためTeX Liveでの構築はしません.また今回の環境構築ではDocker desktopではなくwsl2でdockerを利用します.
Dockerのインストールはこちら
https://www.docker.com/

インストール手順

  1. 上記のURLに移動し,Get Startedをクリック.
  2. Download for Windows を選択し、インストーラーをダウンロードする.
  3. インストーラーが起動したら、OK を押下して次に進む.
  4. インストールが始まるので、待つ.
  5. インストールが完了したら、Close を押下してインストーラーを閉じる.
  6. インストーラーを起動し、Next を押下して、インストールを実行する.
  7. インストールが完了したら、Restart を押す.
  8. Docker Desktop が起動する(チュートリアルを見るか聞かれるが、スキップでも問題ない)
  9. 今回はwsl2で利用するためホーム画面右上の歯車のマークを押して以下の画像で黒くチェックされている所にチェックがされてなかったらチェックをする.

    これでDockerのインストールは完了です.
    試しにターミナルで $ docker run --rm hello-worldを実行し,hello-worldコンテナを起動してみます.

    インストールが成功していれば上記のように表記されます.

3.環境構築で使用したimage

今回使用したimageは初学者でもとりあえず動くことを目標に環境を構築していくために作られたテンプレートを使用しました.
使用したテンプレートはこちら
テンプレートを使用するにあたってフォークをして自身のアカウント内のリポジトリにcloneしなければなりません.
フォークは右上にあるforkをクリックして作成します.

作成すると自身のアカウントのリポジトリにcloneが生成されます.
今回はVSCodeを使っての環境構築なので,cloneしたリポジトリから緑色のCodeをクリックしDownload ZIPを選択してZIPファイルをダウンロードします.

4.VSCode

LaTeXのbuildができる環境構築ソフトウェアの一つで拡張機能が多数ある万能なソフトウェアです.
VSCodeは元々PC内に入っていたためインストール方法は省きます.
VSCodeのインストールについてはここから
本題に入りますが,VScodeでLaTeXの環境構築をしていこうと思います.
VScodeのメニューバーからファイル→ファイルを開く(Ctrl+O)で3. でダウンロードしたZIPファイルを展開したファイルを開きます.

開くとこのようになります.
次にLaTeX環境構築で必須になってくるのは拡張機能です.
今回使用する拡張機能はLaTeX Workshopです.VSCodeを開き,左側にある縦長の選択画面から拡張機能(またはCtrl+Shift+X)を選択して検索すると出てきます.

ローカルであることを確認してインストールを行います.(たまにUbuntuが起動している場合がある)
インストールが終了したら,エクスプローラ(Ctrl+Shift+E)を選択,先程開いたファイルからmain.texを開きます.main.texを開くと左側にある縦長の選択画面からTEXのマークが現れます.また,このmain.texでPDFの文書を書いていくことになります.

TEXのマークを押すとCOMMANDSの中に6つの項目が出てきます.6つの項目の一番上にBuild LaTeX projectがあるのでそれをクリックするとローカルでmain.pdfが生成できます.

以上でLaTeX環境構築とローカルでのmain.pdf生成ができました.

5.githubにpush

先程生成したmain.pdfファイルをgithub上でも生成できるかを確認してみます.
githubでのmain.pdf生成はgithub actionsを利用し,生成物を確認します.
githubに移り,今回利用したimage(フォーク済みのimage)に飛んでActionsを選択.
一番上の"Update main.tex"を選択します.

Aftifactsからpdfが生成されているか確認することができます.

まとめ

今回,初めてLaTeXの環境構築をしてみましたが,スラスラと進むところもあれば詰まる場面もある感じでした.LaTeXはこれからもレポートを書く際に必須になってくるので環境を構築しただけでは終わらずにもっとLaTeXについて勉強していきたいと感じました.

Discussion