all-in-one-latex

iplab-wave/all-in-one-latex + latexindent

$\LaTeX$ on Docker at local VSCode with textlint, latexindent, and GitHub

• ローカル執筆
  • Overleaf よりビルドが速い
  • サーバが落ちない
  • インターネット環境に左右されない
• Docker
  • プラットフォームを問わず簡単に同一の環境を構築可能
• VSCode
  • Dev Container を使うことによって Docker + textlint 環境がワンクリックで作成可能
  • Live Share を使うことによって共同編集が可能
• GitHub
  • バージョン管理が可能
  • GitHub のエコシステム（PR, CI, Projects, Issues, Actions, ...）が使用可能
  • 以下の Actions を作成済み
    • Tag に応じて PDF をビルドして Release を作成する
    • Pull request にビルドした PDF のリンクを貼る
• textlint
  • 文章校正が可能
• latexindent
  • TeX ファイルの自動フォーマットが可能

Usage

1. VSCodeのインストール

Visual Studio Code

Dev Containers 拡張機能のインストール

もし Dev Containers 拡張機能がインストールされていない場合はインストールする。

Dev Containers - Visual Studio Marketplace

2. Dockerのインストール

Get Docker - Docker Docs

3. リポジトリの作成（任意）

GitHub上において「Use this template > Create a new repository」をクリックし、リポジトリを作成する。

テンプレートからリポジトリを作成する - GitHub Docs

4. ローカルにクローン

git clone ...

5. VSCodeにて開く

クローンしたリポジトリをVSCodeで開く。

6. 「Reopen in Container」のポップアップをクリック

VSCode内の右下に表示されるポップアップから、Reopen in Container をクリックすることで、リポジトリがDockerコンテナ内で開かれる。（日本語化している場合は「コンテナーで再度開く」をクリック）

Tip

ポップアップを消してしまったり、なんらかの理由で開かれない場合は、VSCodeのコマンドパレットを開き（Mac: Cmd+Shift+P, Windows: Ctrl+Shift+P）、Remote-Containers: Reopen in Container を選択する。

7. pdf生成方法

（一例。） 保存すれば自動でpdfが生成される。エラーが起きた場合は、ウィンドウ左下の回っている矢印をクリック > Terminate current compilationをクリックして、一旦止める。その後、Clean up auxiliary filesを押し一時的なファイルを削除する。その後、もう一度保存を再開する。