Re:VIEW Template

このリポジトリはRe:VIEW用の書籍テンプレートです。 メンテナンスはTechBoosterが行っています。

• B5紙面サンプル（PDF） 設定がわかるリポジトリはmasterです
• A5紙面サンプル（PDF） 設定がわかるリポジトリはTemplate-A5です。B5とのDIFF
• 電子書籍サンプル（PDF） 設定がわかるリポジトリはTemplate-ebookです。B5とのDIFF

このテンプレートのビルドの仕方は？

細かい準備(TeX入れたり)は『技術書をかこう！』に準じます。

TeXの導入をしない場合でもHTML出力は可能です。Dockerコンテナでビルドすることもできます。

Re:VIEWの使い方は？

技術書をかこう！〜はじめてのRe:VIEW〜改訂版 のリポジトリで解説しています。Re:VIEWに対応した執筆ノウハウ本です。 Re:VIEWの使い方と制作にあたっての企画〜執筆〜編集〜告知〜会場頒布までのノウハウをギュッと詰めています。

https://techbooster.booth.pm/ でPDF版の販売予定があります

環境の準備

本書はAtomでlanguage-reviewとlinter-redpenを導入している前提です。 内部的にRedPenを利用するため、 brew install redpen とかしておいてください。

Atom以外の環境の場合、prhまたはreviewjs-prhとRedPenを自力でなんとか頑張って適用してください。

警告やlintのエラーを放置して編集に突入してしまうと @mhidaka が過労で死にます。 RedPenは試験的に導入したため、知見やルールについてまだ固まっていません。 意見・感想・修正案などあれば @mhidaka までご相談ください。

PDF出力する

rbenvやnodebrewを利用してRubyやNode.jsの準備をしている前提です。 もしそうではない場合、適宜sudoを補うこと。 Node.jsは4.x系以上が必須です。

graphvizを使ったのでbrew install graphvizとかが必要かもしれません。

$ gem install bundler
$ git clone git@github.com:TechBooster/ReVIEW-Template.git
$ cd ReVIEW-Template
$ git submodule init
$ git submodule update
$ npm install
$ npm run pdf

Re:VIEWコマンドでPDFを出力する

セットアップが完了していれば npm run pdf のかわりに

$ cd ReVIEW-Template/articles
$ review-pdfmaker config.yml

でも生成できます。

Dockerを使う

TeXの環境構築が困難な場合、一式セットアップ済みのdockerイメージを用意してあるので使ってください。 Dockerがうまく動くようになっている場合、以下のコマンドで細かい準備なしにビルドを行うことができます。

$ docker pull vvakame/review
$ ./build-in-docker.sh

権利

• 設定ファイル、テンプレートなど制作環境（techbooster-doujin.styなど）はMITライセンスです
  • 再配布などMITライセンスで定める範囲で権利者表記をおねがいします
  • 本設定を使って生成した書籍は現段階のRe:VIEWではソフトウェアたりえません。したがってライセンスは発生しません（あとがきなどへの表記はあると嬉しいものの生成物での表記は不要です）