読者です 読者をやめる 読者になる 読者になる

I'm kubosho_

思想の固まり

Re:VIEW + RedPen + Travis CIの環境を構築できるboilerplateを作った

夏コミに向けての進捗どうですか。

ブーメランを投げたところで、「執筆環境を整えて自動校正やgh-pagesへのデプロイもしてくれる」Re:VIEW boilerplateを作ったので紹介します。

リポジトリ:https://github.com/kubosho/review-boilerplate

Re:VIEW boilerplateとは

以下の機能を提供します。

  • Re:VIEWフォーマットからWebページやPDFを出力する
  • RedPenでRe:VIEW文書を自動校正する
  • Travis CIを使った継続的インテグレーションをする
  • gh-pagesへの自動デプロイ(Travis CIでビルドが正常終了した場合)

ライセンスもMIT Licenseなので、ライセンスと著作権表示さえしていただければ、あとは好きなように使えます。

Re:VIEW boilerplateの使いかた

READMEにも書いていますが、簡単に使いかたを書いていきます。

とりあえずWebページとして出力する

Node.jsとRuby + Bundlerさえインストールされていれば、以下のコマンドを実行するだけでarticles/book/内にindex.htmlができます。

npm run setup
npm run web

PDFを出力する

PDFを出力するときは別途TeXのインストールが必要になります。 TeXのインストールについてはTechBooster/FirstStepReVIEWを参照してください。 TeXがインストールされていれば、以下のコマンドを実行することでPDFが出力されます。

npm run pdf

Re:VIEW boilerplateを作ったきっかけ

2015年の冬コミで初めてRe:VIEWを使って執筆をしました。 2014年の夏コミではAsciidoctorを使いましたがRe:VIEWを比較した場合、Re:VIEWは以下の利点がありました。

  • 独自記法がAsciiDocと比べるとRe:VIEWのほうが簡潔
  • WebページやPDFへ変換するのが簡単
  • 日本において、Re:VIEWは多く実績がある

そのため今回の夏コミにて再びRe:VIEWで執筆することにしました。

そしてこれからもRe:VIEWで執筆しようと思ったため、ここらで環境構築をしておいて後は楽したいと思い、Re:VIEW boilerplateを作りました。

Re:VIEW boilerplateの使用例

この夏頒布予定のSteins;Git 0という「Steins;Gateの世界観をGitで説明する薄い本」で使っています。

他には使われていないので、ぜひ使ってみてください。そして気づいたことがあれば、issueやPull Requestを送ってください。