Techbook Template

このリポジトリはRe:VIEW用のTechBooster製テンプレートのカスタム版。

主な相違点

• GithubおよびGithub Actionsを前提に他の環境用の設定を削除。
• ドキュメント類も削除。
• 校閲をtextlintとreviewdogに変更。

基本的な使い方

1. Github上でUse this templateからリポジトリを作成。
2. ローカルにclone。
3. 開発ブランチを切る。
4. articles/main/下に記事本文を書く。
5. articles/catalog.ymlに記事本文ファイルを指定する (このとき拡張子はmdからreに変更する)。
6. PRをmainブランチに発行する。
7. 校閲が走る。
8. PRをmergeする。
9. Github ActionsのArtifactsにPDFが出力される。

ローカルでのビルド

以下を実行すると、out/下にPDFが生成される。

$ docker-compose up

ライセンス

• articles/styにあるファイルには以下のライセンスが適用されています。
  • review-jsbook.cls, review-base.sty, review-style.sty, review-custom.sty: MIT License
  • jumoline.sty: The LaTeX Project Public License
  • plistings.sty: MIT License
  • gentombow.sty: BSD License
  • jsbook.cls: BSD License
• 上記以外のコードについてはリポジトリのLICENSEファイルに従います。