ゼロコンフィグで Re:VIEW 原稿を PDF に変換できる Opinionated な Re:VIEW ビルダーです。
- ゼロコンフィギュレーション
- 原稿データ（
.re,images）と組版ファイル（.sty,.css等）を分離し、原稿の執筆に集中できる環境を構築する - 組版関連ファイルを
theme単位でフォルダにまとめているので、後からのテーマの追加と切り替えが容易 - Docker ベースのビルドにより、TeX 等の環境依存ゼロ
- GitHub Actions による自動ビルド
このリポジトリをフォーク（または単にクローン）します。
➜ git clone https://github.com/vibranthq/opinionated-review book
➜ cd book
articles/の中にある.reファイルを編集します。
そして、make pdfあるいは単にmakeを実行するとarticles/*.reの原稿が PDF になってdist/へ出力されます。
➜ make
===> Using theme 'techbooster'
===> Copying sources to the container
===> paper size: A5
===> extra config:
{
"texdocumentclass": [
"review-jsbook",
"media=print,paper=a5,serial_pagination=true,hiddenfolio=nikko-pc,openany,fontsize=9pt,baselineskip=13pt,line_length=38zw,number_of_lines=37,head_space=15mm,headsep=3mm,headheight=5mm,footskip=10mm"
]
}
===> Compiling Re:VIEW sources
===> Done
===> Pushing back artifacts to the local dir
Docker Hub からopinionated-reviewイメージを Pull します。
docker pull vibranthq/opinionated-review
.reファイルがあるソースフォルダを/inに、PDF を出力したいターゲットフォルダを/outに指定して、opinionated-review pdfを実行します。
この例では./articlesをソースフォルダに、./distフォルダをターゲットフォルダにしています（絶対パス）。
docker run -it --rm -v ${PWD}/articles:/in -v ${PWD}/dist:/out vibranthq/opinionated-review
上記のコマンド群は
Makefileにも定義されています。 原稿データから PDF を生成したい場合は、make pdfあるいは単にmakeを実行してください。
docker run -it --rm vibranthq/opinionated-review --helpでヘルプを表示できます。
epubコマンドで EPUB 形式の本を書き出すことができます。
docker run -it --rm \
-v ${PWD}/articles:/in \
-v ${PWD}/dist:/out \
vibranthq/opinionated-review epub
pdf-ebookコマンドで eBook 向けの PDF を書き出すことができます。
docker run -it --rm \
-v ${PWD}/articles:/in \
-v ${PWD}/dist:/out \
vibranthq/opinionated-review pdf-ebook
opinionated-reviewはpress-readyに標準対応しています。
make press-readyを実行すると、原稿データが印刷所に入稿可能な状態の PDF に変換されます。
lintコマンドでprhによる文章チェックができます。
docker run -it --rm -v ${PWD}/articles:/in vibranthq/opinionated-review lint
あるいはmake lintを実行しても同様です。
現在対応している組版スタイルのリストです。
techboosteropinionated-review/themes/techbooster
opinionated-reviewに--theme=<theme>オプションを渡すことで使用できます。
docker run -it --rm \
-v ${PWD}/articles:/in \
-v ${PWD}/dist:/out \
vibranthq/opinionated-review pdf --theme=techbooster
opinionated-reviewに--theme=<path/to/theme>オプションを渡すことでカスタムテーマを使用できます。
デフォルトでは A5 サイズで出力されます。
サイズを変更する方法が 2 つあります。
選べるサイズはテーマに依存しています。例えばtechboosterテーマではA5とB5が選べます。
.reファイルがあるフォルダにopinionated-review.ymlファイルを作成し、内容を次のようにします。
paper: B5docker run <省略> vibranthq/opinionated-review pdf --paperSize B5のように--paperSizeオプションで用紙サイズを指定できます。
新しいイメージを Pull することでアップデートできます。
docker pull vibranthq/opinionated-review
name: Build
on: [push]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- uses: vibranthq/build-review@v1
with:
format: pdf
- uses: vibranthq/build-review@v1
with:
format: epub
- uses: actions/upload-artifact@master
with:
name: Artifacts
path: ./distPull Request & Issue 大歓迎です。
- プリセットテーマの追加
- ローカルのテーマフォルダ（
styやcssの集まり）を指定できるようにする
See Contribution Guide.