fillu87gyc / cytex

GitHub Codespacesを用いた 環境構築が容易な 日本語LaTeX執筆環境テンプレート

CyTeX（読み方：さいてふ）は、GitHub Codespaces を用いた、環境構築が容易な日本語用の LaTeX 論文執筆環境テンプレートです。 ローカル環境に texlive や Docker をインストールせずに、GitHub Codespace 上のクラウド開発環境に LaTeX 環境を構築できます。 また、devContainer を用いて、Codespace 環境ではなくローカル環境に構築することも可能です。

demo.mp4

使用手順

以下のファイル/フォルダをあなたの LaTeX 執筆環境にコピーしてください。

• .devcontainer/*
• .vscode/*
• main.tex（名前は変更可）
• .gitignore

また、執筆論文指定の形式に合わせて、任意のスタイルファイルを追加してください。

LaTeX コンパイル環境の構築手順

以下 2 通りの方法があります。

1. Codespaces を用いてクラウド開発環境に構築する方法
   • 注意：無料で使用できる月間ストレージとコア時間 の上限に達した場合、2 の方法か、他の執筆環境を構築する必要がある
2. devContainer を用いてローカル環境に構築する方法

ビルド手順

以下 2 通りの方法でビルドできます。

1. *.tex ファイルを保存する
2. ターミナルで latexmk ./main.tex を実行する

ビルドすると、out/ に PDF ファイルが生成されます。

Codespaces 利用上の注意

• 無料で使用できる月間ストレージとコア時間 には上限があります。
  • GitHub Pro アカウントの場合は 180 コア時間/月で、2 コアから選択できるので月 90 時間分に相当します。
  • コア時間は、Codespace が Active 状態の時間がカウントされます。
• Codespace の状態は、github.com/codespacesから確認、管理できます。
• 現在の請求月に使用した Codespaces コンピューティング使用量は、github.com/settings/billing の Codespaces から確認できます。
• 非アクティブな時間が経過すると、codespace は自動停止します。
  • タイムアウト時間はデフォルトで 30 分に設定されています。
  • 参考：GitHub Codespaces のタイムアウト期間を設定する
• Active な Codespace は以下のいずれかの方法で手動停止できます。 （参考：codespace の停止と開始）
  • VSCode または Browser Codespace で、左下の><アイコン > Stop Current Codespace を選択する
  • github.com/codespaces にアクセスし、Active な Codespace の … から Stop Codespace を選択する

Welcome Contribution

不具合・要望を記載したissue を作成した上で、Pull Request してください。

Author

Ran350