研究室に入ってきた後輩用に、OverleafとGitHubを用いたLaTeX環境構築の方法をまとめました。

ローカルでLaTeXを使うのもいいですが、 Overleafを使うと共同編集がしやすくLaTeX初学者にはおすすめです。 また、GitHubと連携することでバージョン管理ができるので、修正箇所の追跡がしやすくなります。 Overleafでやるメリットは先輩に卒論修正を手伝ってもらえるところです。

1. Overleafのアカウント作成

Overleafのアカウントを作成します。OveleafだとpLatexなどが初期で入っていないのでlatexmkrcを使って設定します。latexmkrcというファイル名で以下を保存してください。

$latex = 'platex';
$bibtex = 'pbibtex';
$dvipdf = 'dvipdfmx %O -o %D %S';
$makeindex = 'mendex %O -o %D %S';
$pdf_mode = 3; 
$ENV{TZ} = 'Asia/Tokyo';
$ENV{OPENTYPEFONTS} = '/usr/share/fonts//:';
$ENV{TTFONTS} = '/usr/share/fonts//:';

2. GitHubのアカウント作成

GitHubのアカウントを作成します。 学生は有料版が無料で使えるので、学生用のmailアドレスで登録することをおすすめします。

3. OverleafとGitHubの連携

Overleafに課金するとGitHubとの連携ができるようになります。 KomnenaがOverleaf有料版を使っているので、Komnenaが作成したプロジェクトを共有する形をとっています。

4. GitHub Actionsの設定

GitHub Actionsを使って、LaTeXのコンパイルを自動化します。 以下のような設定ファイルを.github/workflows/main.ymlとして保存してください。

# This is a basic workflow to help you get started with Actions
name: Build LaTeX document

# Controls when the workflow will run
on:
  push:
    paths:
    - 'main.tex'

jobs:
  build_latex:
    runs-on: ubuntu-latest
    steps:
      - name: Set up Git repository
        uses: actions/checkout@v2
      - name: Compile LaTeX document
        uses: xu-cheng/latex-action@v2
        with:
          root_file: main.tex
          compiler: latexmk
          args: -pdfdvi
      - name: Copy PDF file
        run: mkdir docs && cp main.pdf docs/
      - name: Deploy pages
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./docs

これを設定すると、毎回OverleafからプッシュするたびにGitHubn内でGitHub Actionsが動きgh-pagesというブランチにpdfが出力されます。Overleafが動かなくなった際のバックアップに使えます。

5. おわりに

以上でLaTeX環墧構築の方法をまとめました。 LaTeXは初めは難しいですが、慣れてしまえば楽しいです。 ぜひ、LaTeXを使って論文を書いてみてください。