blacktanktop / latex-template-en

Latex-Template-EN

概要

• commitをpushすればGitHub Actionsによってビルドされる。
• デフォルトテンプレートはIEEE conference format
• tagをpushすればリリースも可能。
• 基本ローカル環境で確認したものをpushする前提で作成

使い方

ローカルでビルドしたいだけのとき

• ローカルでDockerを使える状態にする。
• このテンプレートをforkする。
• 自分が使いたい論文のTeXフォーマットと差し替える。
• 論文の内容を書くメインのtexファイル名をmain.texと変える。
• make latexmk を実行。

GitHub Actionを使ってリリースしたいとき

• ローカルでビルドしたいだけのとき までを実行する
• GitHubにmainにpushする。(これだけではReleaseされない)
• git tag -a vtest -m 'テスト' のようにtagをcommitする。
• git push origin vtest tagをpushする。
• これできちんとビルド出来る状態のものをpushしていればReleasesのところにmain.pdfができる。

[注意]pushがCIのフックになっているので、軽いcommitでCIを回したくないときは

• git commit -m "Fix result section. skip ci" のようにskip ciという文字列をコミットメッセージに入れる

ローカルで実行に問題が発生したとき（TeX詳しくないので適当な対応策）

• とりあえずエラーを読む。（よくわからん事が多い）
• .latexmkrc の
  • $latex のpdflatexをupdflatex, platex, uplatexに変えたりする。(そんなようなコメントが出ているときがあるので気付けるはず）
  • $latex_silent 上と同じものに変更
• bblとかリファレンス周りで変なことがおきていそうなら
  • $bibtex のupbibtexを pbibtexに変えたりする。

参考

GitHub Actions部分は https://github.com/metaVariable/latex-ci-template を参考にしました。

Makefile部分は https://github.com/p-geon/DockerBonsai/tree/main/paper-writing を参考にしました。