✍️

Re:VIEW環境構築メモ

2023/01/29に公開

review

idea

技術同人誌をRe:VIEWで書く

技術同人誌を書きたいなと思ったりしています。まずは環境から整えたくなるタイプなので、ツールを調べてブログにまとめたりしていました。

よく使われているのがRe:VIEWのようなので、一度試してみることにしました。

OSはmacOSで試しましたが、Windows（WSL2）でもLinuxでも大丈夫だと思います。

Dockerとか、Re:VIEWが何か等は、ある程度分かっている前提です。

TechBoosterのテンプレートを使う

以下のテンプレートがRe:VIEWの新しいバージョンに対応していて良さそうでした。

私は、上記のものをforkして、自分好みにいくつかカスタムしました。

GitHubの「Use this template」から、新しいリポジトリを作成できます。

そのあと、以下コマンドでテンプレートをダウンロードします。

$ git clone https://github.com/karaage0703/ReVIEW-Template
$ cd ReVIEW-Template

ビルド（テキストファイルからpdfファイルの生成）には、Dockerを使います。Dockerに関しては説明やセットアップは省略します。以下の記事参照ください。

以下コマンドでRe:VIEW環境が揃ったDockerイメージをダウンロードします。

$ docker pull vvakame/review:5.5

ReVIEW-Template直下で、以下コマンドで、PDFが生成できます。

$ ./build-in-docker.sh

上記は印刷用のpdfです。電子書籍用のpdfファイルはコンフィグファイルとしてconfig.ymlでなく、config-ebook.ymlを指定する必要があります。私のカスタムしたリポジトリだと、以下コマンドを実行すると、電子書籍用のPDFが作成できます。

$ ./build-in-docker-ebook.sh

これでarticlesディレクトリ直下にReVIEW-Template.pdfというファイルが生成されます。

あとは、articlesディレクトリのファイルをベースに、執筆することができます。

VS Codeエディタでの執筆環境

エディタはVS Codeを使うときは、atsushienoさんのRe:VIEW拡張機能を入れるのが良さそうです。

拡張機能を入れたら.re拡張子のファイルを選択すると、右上に「Show preview」と表示されるので、クリックすると以下のようにプレビュー画面が表示されます。

私のカスタムしたリポジトリには、上記の拡張に加えて、以下ブログ記事の内容をベースに.vscodeディレクトリを追加してVS Codeエディタの設定をカスタムしています。

参考：Re:VIEW Starterを使う方法

他、ネットを調べると Re:VIEW Starterを使う方法も出てきました。

使い方としては、以下のサイトで基本的な設定を選ぶと自動でテンプレートが作成されます。

https://kauplan.org/reviewstarter/

あとは、作成されたテンプレートmybook.zipに対して、以下コマンドでpdfが作成できます。TechBoosterのテンプレートと同じ要領ですね。

$ unzip mybook.zip
$ cd mybook
$ docker pull kauplan/review2.5 
$ docker run --rm -v $PWD:/work -w /work kauplan/review2.5 rake pdf

こちらでも問題なくpdfが生成できたのですが、Re:VIEWのバージョンが2.5と古いのがちょっと気になったので、TechBoosterの方がよいのかな？と思っています。

Re:VIEWの書籍

以下で最初に紹介したテンプレートを作成している、TechBoosterさんの書籍が読めます。

以下のリポジトリで公開されていて、Re:VIEWを使って自分でビルドすればpdfで読むこともできます。

ただ、自分はエラーが出て自力でビルドできず…でした。

まとめ

Re:VIEWの執筆環境に関して試してまとめてみました。実は、最初はTeXのローカルのビルド環境を構築しようとしたのですが、うまくいかずにRe:VIEWに手を出してみたという経緯があったりします。

Re:VIEW環境で技術同人誌を書くことは、これでできそうな気がしますし、生成されたpdfはデフォルトでも見栄えがそれなりに良いのは嬉しいですね。

ただ、Googleドキュメントとかに比べると、やはりだいぶ手軽さでは劣りますね。環境構築を意識せずとも、ハイクオリティに印刷できるような、書くことに集中できる執筆環境があるとよいのですけどね。

追記：Re:VIEWの執筆Tipsに関しては、以下記事でまとめています。

参考リンク

エムスリーさんのテンプレート。良さそうですが、まだ試せてはいません。

変更履歴

2023/05/19 カスタムリポジトリ・執筆TIPSリンクに関して追記