Re:VIEW
/icons/GitHub.icon kmuto/review
https://raw.githubusercontent.com/kmuto/review/refs/heads/master/doc/images/review-generate.png
https://github.com/kmuto/review/blob/master/doc/images/review-generate.png
OSSの組版ソフトウェア。コミュニティにより開発が続けられている。
長年開発が実施され、多彩な出力形式を持つ。
導入(Docker)
vvakame氏が配布しているDockerイメージに必要な全てが揃っています。
TechBoosterテンプレートを使用している場合(build-in-docker.shがある場合)
code:bash
$ docker pull vvakame/review:5.9
$ ./build-in-docker.sh
build-in-docker.shがない場合
.reファイルがあるディレクトリ、ビルドに使うコマンドを調べておきます。
code:bash
$ docker run --rm vvakame/review:5.9 rake pdf
導入(ローカル)
ローカルのRe:VIEWでのPDF出力にはLaTeXが必須になります
LaTeXは巨大なツールで、インストールするには数時間待たされます
急いでいる人、LaTeX自体をそこまで使う予定がない人はDockerを使ったほうが幸せだと思います
Re:VIEWのインストール
Rubyが必要なので、ない人は先にRuby環境を整えてください
code:bash
$ gem install review
TeX/LaTeXのインストール
現在のTeX/LaTeX環境構築は、TeX Liveというディストリビューションを丸ごと入れるのが定番になっています
大量のツールを一気に導入するのでとてもとても時間がかかりますが、一度入れてしまえばツールの不足によるエラーに悩む可能性を下げられます
TeX WikiにOSごとのインストール方法が載っているので従ってください
導入でき、パスも通っていればPDF生成コマンドが成功するはずです
code:bash
$ rake pdf
GitHub ActionsでPDFを生成する
GitHub Actionsは、リポジトリに対してGitHub上で処理を実行する、いわゆる継続的インテグレーション(CI)サービスです
.githubディレクトリに設定ファイルを入れておけば、プッシュやプルリクエストのタイミングでPDFを生成し、ダウンロードできる状態(Artifact)で置いておく事ができます
自分の環境に何も入れなくてもPDFが見られるので、面倒な場合や外出中の場合に便利です
最新のTechBoosterテンプレートには設定が入っているので、ForkすればActionsが実行されます
自力で設定する場合
サンプルの設定ファイルを記載します。ArtifactとしてPDFファイルをあとからダウンロードできるようになっています
GitHub Actionはアップデート等でバージョンが新しくなる場合もあるため、最新の情報を参考にしてください
code:.github/workflows/on_push.yml
on: push
jobs:
pdf:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Build PDF
run: |
docker run -v ${{ github.workspace }}:/work --workdir /work vvakame/review:5.9 bundle && bundle exec rake pdf
- uses: actions/upload-artifact@v4
with:
name: PDF
path: |
./*.pdf
#tech