Zenn
team411Publicationへの投稿
🍣

少し頑張る理数系LaTeX環境構築 (Dev Container)

えぐち
2024/03/29に公開
LaTeX
devcontainer
tech

お急ぎの方 → 構成ファイルを入れる

はじめに

入学して早々LaTeXのインストールを急かされる大学があるそうですが．
世の中にはLaTeXの記事が無限にあって，初心者お断り仕様です．さらにこの記事が投稿されてもっと複雑に！
さて，この記事の主題は「Dev ContainerでLaTeXしよう」です（もっというと自分用にイメージを作ろうデス）
LaTeXはMacとかWindowsとかでインストール方法が異なって，さらに個人のパソコンの状態によってインストールに失敗したりします！やだ！
ところでDev Containerを使うと「デバイスに依存しない」「ローカル環境を汚染しない」開発ができます．
おっと．つまりそういうことですね，やるしかない

対象読者

ちょっと待った．本当にこの記事に沿ってインストールする？
とにかくLaTeXが書ければいい！ という方はこっちの記事をおすすめします
https://zenn.dev/e_chan1007/articles/8029f3f9dff2be

それでもこっちを読んでくれるあなたに，この記事のタイトル「少し頑張る」をすると以下のメリットがあるよ

  • PCのローカル環境が汚れない
  • インストールに失敗しない（Docker，VSCodeとかのインストールは知らん）
  • インストール時間が短い[1]
  • なんかかっこいい！！（重要）

また，パソコン初心者向けに書いても需要が空集合になると察したので，VSCodeとかある程度触れるよ！そんな人向けに書きます

必要なインストール

この記事通りに進めればOK！（英語に負けるな）

https://code.visualstudio.com/docs/devcontainers/tutorial

構成ファイルを入れる

Dev Containerの構成ファイルを選ぶフェーズで以下を入力してください

ghcr.io/eguchi1611/texlive-sci-ja/template

以上ですね．Dev Containerを開いてターミナルからuplatex -versionで確認してください

最後に

思ったより書くことがありませんでした．Dev Containerはシンプルでいいね！
意外と洗練されたLaTeXのDev Containerが見つからなかったのでこの機会に作成しました．
この開発過程も下に記しておくので興味ある方は是非．
ここまで読んでいただきありがとうございます！役に立っていたら幸いです．質問等はコメントへ

番外編

Dockerイメージの開発

イメージの開発にかなり時間を割きました．私の結論（思い出）はこのリポジトリに詰まっています．
https://github.com/eguchi1611/texlive-sci-ja
せっかくなので解説します．私の本当の環境構築のおすすめは，自分好みのイメージを作ることです．これを参考にどうですか？

まずベースイメージの選定ですが，buildpack-deps:bookworm-scmです．デフォルトテンプレ群のイメージのベースがこれだからです．
具体的にはmcr.microsoft.com/devcontainers/baseがベースですが，これはただbuildpack-depsと，後述するfeaturesを合体させてるだけです．

次はDockerfileの作成です．世の中にはTeX LiveのDockerイメージが大量に落ちています．それを片っ端から読み漁りました．
こうなりました．

Dockerfile
FROM buildpack-deps:bookworm-scm

ARG TEXLIVE_MIRROR=https://tug.ctan.org/systems/texlive/tlnet

ENV PATH=/usr/local/texlive/bin:$PATH

WORKDIR /texlive-install

COPY ./texlive.profile .

# texliveをインストール
RUN wget ${TEXLIVE_MIRROR}/install-tl-unx.tar.gz \
  && tar -xf install-tl-unx.tar.gz --strip-components 1 \
  && ./install-tl -profile texlive.profile --location ${TEXLIVE_MIRROR} \
  && ln -sf /usr/local/texlive/*/bin/* /usr/local/texlive/bin

# latexmkのインストール
RUN tlmgr install latexmk

# GhostscriptとGnuplotをインストール
RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
  && apt-get -y install --no-install-recommends ghostscript gnuplot \
  && rm -rf /var/lib/apt/lists/*

WORKDIR /usr/local/texlive/texmf-local/tex/latex/gnuplot

# gnuplot-lua-tikzをインストール
RUN gnuplot -e 'set term tikz createstyle' \
  && mktexlsr

WORKDIR /

RUN rm -rf /texlive-install

以下ポイント

  • TeX Liveはミラーによって速度が変わりまくるのでARGでミラーを選択できるように
  • インストールされるパスに2023などのバージョンが入るのでシンボリックリンクと環境変数でいい感じに調整

さてインストールプロファイルを作成しましょう．イメージのサイズを下げるために厳選してあります．理数系と言っている根拠はここなので，自分好みに変えるチャンスポイントです．私のイメージではこんな感じです．

texlive.profile
# https://tug.org/texlive/doc/install-tl.html#PROFILES
selected_scheme scheme-custom

collection-basic 1
collection-fontsrecommended 1
collection-langcjk 1
collection-langjapanese 1
collection-latex 1
collection-latexextra 1
collection-latexrecommended 1
collection-mathscience 1
collection-pictures 1

tlpdbopt_install_docfiles 0
tlpdbopt_install_srcfiles 0

ここまででDockerのイメージは完成ですね．でもDev Containerのイメージの作成は一工夫必要です．
Common UtilitiesというDev Container Featuresが必要です．これを入れるとターミナルがいい感じに今のブランチ名を出してくれたり，良い恩恵が得られます．公式のDev Containerイメージはこれが入っています．こいつも含めた状態でイメージをビルドしたいですね．GitHub Actionsで済ませます．
Actionsでイメージのビルドといったら！docker/build-push-actionではありません．Dev Containerのイメージのビルド用Actions[2]があります．devcontainers/ciですね．これを使ってビルドすると，Dev ContainerのFeatures，もっというとVSCodeの拡張機能と設定も全部まとめて1つのイメージにしてくれます！ナイス！
私のは以下のdevcontainer.jsonが適用された状態のイメージが出てきますよ．

devcontainer.json
{
  "name": "TeX Live",
  "build": {
    "dockerfile": "Dockerfile"
  },
  "features": {
    "ghcr.io/devcontainers/features/common-utils:2": {
      "username": "vscode"
    },
    "ghcr.io/devcontainers/features/git:1": {}
  },
  "customizations": {
    "vscode": {
      "extensions": ["James-Yu.latex-workshop"],
      "settings": {
        "latex-workshop.latex.recipe.default": "latexmk (latexmkrc)"
      }
    }
  },
  "remoteUser": "vscode"
}

Actionsファイルはこうです

build.yml
name: "Pre-build TeX Live Dev Container Image"

on:
  push:
    branches:
      - "main"
  schedule:
    - cron: "0 0 * * 0" # 毎週日曜 (UTC)
  workflow_dispatch:

env:
  REGISTRY_IMAGE: ghcr.io/eguchi1611/texlive-sci-ja

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
      - name: Set up QEMU
        uses: docker/setup-qemu-action@v3
      - name: Set up Docker Buildx
        uses: docker/setup-buildx-action@v3
      - name: Login to GitHub Container Registry
        uses: docker/login-action@v3
        with:
          registry: ghcr.io
          username: ${{ github.repository_owner }}
          password: ${{ secrets.GITHUB_TOKEN }}
      - name: Pre-build dev container image
        uses: devcontainers/ci@v0.3
        env:
          BUILDX_NO_DEFAULT_ATTESTATIONS: true
        with:
          imageName: ${{ env.REGISTRY_IMAGE }}
          cacheFrom: ${{ env.REGISTRY_IMAGE }}
          platform: linux/amd64,linux/arm64
          subFolder: ./src
          push: always

これでイメージが完成です！

Dev Containerのテンプレートの作成

いざイメージができても，毎回devcontainer.jsonファイルを手書きするのはスマートではないですね．公式のテンプレートは自動で色々ファイルを吐き出してくれます．それを作ろう．
GitHubのActions，devcontainers/actionです．こいつがいい感じにしてくれる．
公式が分かりやすいので貼っておきますね
https://github.com/devcontainers/template-starter

以上！番外編の方が長くなってしまった．
いい感じのLaTeXライフが送れますように．

脚注

  1. TeX Liveのミラーは主に激遅だが，これはGHCRからダウンロードするため ↩︎

  2. Dev Container CLIのbuildをActionsにしてくれたやつ ↩︎

GitHubで編集を提案
team411
team411Publication

Discussion