Re:VIEWの環境を整える

2019/01/11

Re:VIEWは書籍作成支援ツールです。

Re:VIEWフォーマットという独自のマークアップ言語からPDFやEPUBなどを生成できます。主に日本語の技術書をターゲットにしていて、技術書系同人出版のデファクトっぽい位置を占めているようです。

環境構築

Re:VIEWをWindows10で使いたくなったので環境構築。Re:VIEWはRubyで作られていて、PDF生成にはLaTeXが必要です。どちらもWindowsとあんまり相性がよくないので直接インストールは避けたいところ。

そこで、Dockerで環境を整えてしまうことにしました。vvakame/docker-review をありがたく使わせてもらいます。

Re:VIEWのlatestは3.0ですが、出たばかりでノウハウが溜まっていない感じがするので2.5を選びました。

$ docker pull vvakame/review:2.5
2.5: Pulling from vvakame/review
(snip)
Status: Downloaded newer image for vvakame/review:2.5

イメージが取得できたので雛形を作成してみます。

$ docker run --rm -v `pwd`/:/work vvakame/review:2.5 /bin/sh -c "cd /work && review-init hello"

ちなみに、 docker run の -v オプションはホスト側の任意のパスをコンテナの任意のパスにマウントするもの。 –rm オプションはコンテナ終了時にコンテナを自動で削除するもの。

PDFを生成してみます。

$ docker run --rm -v `pwd`/hello:/work vvakame/review:2.5 /bin/sh -c "cd /work && review-pdfmaker config.yml"

無事動きました。

執筆環境

執筆環境はAtomを選びました。ReVIEW用の拡張機能 language-review が決め手。Visual Studio Codeにも類似の拡張機能があるようです。

記法は覚えるの大変なのでチートシートを頼ります。

公式のフォーマットガイドは review/format.ja.md at master · kmuto/review にあります。

さらに込み入った使い方は「はじめてのReVIEW」という書籍がよさそう。この書籍、ありがたいことにTechBooster/FirstStepReVIEW からPDFを生成できます。個人利用なら無償でOKとのこと。

これで技術書を書く基盤が整いました。あとは中身だけ...




おススメ