📝

ローカルのOverleafでLaTeX執筆環境をセットアップする手順

2022/07/17に公開

この記事では、ローカルのOverleafでLaTeX執筆環境をセットアップする手順について紹介します。

はじめに

何かしらドキュメントを書く時、大抵の場合は Markdown で間に合うでしょうけれど、まだまだ LaTeX も便利で良いものです。

また、最近はWebブラウザで使えるオンラインLaTeXエディターサービスのOverleafに登録して、それを使うケースも増えてきたように思います。[1]

今回は(あえて Overleaf に登録せずに)、Ubuntu 20.04 DesktopのローカルでOverleafを動かしてLaTeXの執筆環境を構築する、ということをしてみます。

セットアップ

Overleafの official wiki for install guides にある Quick-Start Guide が参考になります。

こちらを見ながらステップバイステップで進めましょう。

準備

あらかじめ次のものが必要です。

  • bash
  • docker
  • docker-compose

まずは次のコマンドを実行して、問題なくバージョンが表示されることを確認します。[2]

bash --version
docker version
docker compose version

リポジトリのクローン

それから適当な場所でリポジトリをクローンして、そのリポジトリのディレクトリへ移動します。

git clone https://github.com/overleaf/toolkit.git ./overleaf
cd overleaf/

設定ファイルの生成

設定ファイルを生成するために次のコマンドを実行しましょう。

bin/init

カレントディレクトリの config/ の中に、次の3つの設定ファイルができていると思います。

  • overleaf.rc
  • variables.env
  • version

コンテナの起動

最後に次のコマンドでコンテナを起動すれば、ひとまずセットアップは完了です。

bin/up

コンテナの起動後にWebブラウザで http://localhost/launchpad にアクセスすると、Overleafの管理者アカウント作成画面が表示されると思います。

Overleafの管理者アカウント作成画面
Overleafの管理者アカウント作成画面

エラーが起きた時は

bin/docker-compose 中の docker-composedocker compose に修正しましょう。[3]

bin/docker-compose
+  exec docker compose -p "$project_name" ${compose_file_flags[@]} "$@"
-  exec docker-compose -p "$project_name" ${compose_file_flags[@]} "$@"

修正後にもう一度 bin/up すると、今度はエラーなくコンテナが起動します。

動作確認

はじめにOverleafの管理者アカウント作成画面で、適当にアカウントを作ります。

次にログイン画面が表示されますから、入力したメールアドレスとパスワードでログインします。

ログインできたら【Start Using Our Overleaf Instance】と進み、【Create First Project】でプロジェクトを作りましょう。プロジェクトは次の3種類から選ぶことができます。

  • Blank Project
  • Example Project
  • Upload Project

Example Project を選んでプロジェクト名を入力すれば、次にようにソースファイルとコンパイル結果のプレビューがブラウザに表示されます。

Example Projectがコンパイルできた
Example Projectがコンパイルできた

お疲れ様でした。

日本語対応

と言いたいところですが、実は、上記までだと日本語に対応できていません。

日本語に対応できるように、コンテナのTeX Live環境をフルインストール版に更新しましょう。

コンテナのTeX Live環境の更新

まず、次のコマンドでコンテナの中に入ります。

docker exec -it sharelatex bash

コンテナの中で次のコマンドを実行し、TeX Liveをフルインストール版に更新します。更新できたらコンテナを exit で抜けましょう。

tlmgr update --self
tlmgr install scheme-full
exit

続いて、次のコマンドでコンテナに加えた変更を新しいイメージとしてコミットします。

docker commit sharelatex sharelatex/sharelatex:with-texlive-full

また、新しいイメージでコンテナが起動するように bin/docker-compose を修正しておきます。

bin/docker-compose
+  local full_image_spec="$image_name:with-texlive-full"
-  local full_image_spec="$image_name:$SHARELATEX_IMAGE_VERSION"

最後に bin/stop を実行してから bin/up して、コンテナを起動し直しましょう。

日本語対応の動作確認

改めて http://localhost へアクセスし、日本語を含むソースファイルがコンパイルできることを確認して完了です。

日本語を含むLuaLaTeXソースファイルをコンパイルしている様子を次に示します。[4]

日本語を含むLuaLaTeXソースファイルがコンパイルできた
日本語を含むLuaLaTeXソースファイルがコンパイルできた

LaTeX執筆環境が整い、ドキュメントを書いていけるようになりました。お疲れ様でした。

おわりに

今回はローカルのOverleafでLaTeX執筆環境をセットアップする手順について紹介しました。どなたかのお役に立てば幸いです。

脚注
  1. LaTeXを使うために TeX Live をインストールしなくて良くなったのは隔世の感がありますね。 ↩︎

  2. docker-compose から docker compose とコマンドがハイフンなしに変わっていることに注意です。 ↩︎

  3. この記事をアップする頃には、既に修正されているかも知れませんが。。。 ↩︎

  4. このソースファイルの例は LuaTeX-ja の使い方 から引用しました。 ↩︎

Discussion

ログインするとコメントできます