経緯
諸事情により、技術書典9の原稿を今から(今から!?)書いていてるんですが、実はちゃんとした技術書を書くのは初めてなのです。(今まで出版していたのは全部漫画だったので、クリスタで編集できちゃったんですよね)
で、初めてなのでどうしたらいいものなのかと困っていたのですが、 検索したところ「Re:View Starter」が便利という情報を多数見かけたので、試してみることにしました。
Re:View と Re:View Starter の導入
僕のパソコンには偶然 gem
も mac用TeX
も入っていたので、本当に導入が楽でした。
この2つのインストール方法はRe:VIEW Starter ユーザーズガイドを参考にするといいと思います。
gem install review --version=2.5
そして、Re:View Starter のサイトに行き、原稿の設定を .zip
でダウンロード。
このzipを展開し、ディレクトリの中以下のコマンドを打ちます。
rake pdf
これだけで本が作れます。あとは原稿を書くだけ。すごすぎる。
つまづいたところ
一瞬で解決しましたが、ハードタブ(Tab)が必要な場面(表のセル分割)で、VSCodeのデフォルトだと、ソフトなタブ(Space)になってしまうところを修正する必要が出てきました。
これに関しては以下の記事が参考になると思います。
めちゃくちゃ良いと思ったところ
(1) ドキュメントが神
著者は Re:View Starter の作者の方でしょうか。デフォルトでコンパイルテストをすると生成される PDF (たぶんユーザーズガイドと同じ)が Re:View Starter のドキュメントになっており、これを読むだけで書き方が全部分かりました。本当に丁寧でよくできていると思います。
(2) 自動リロード付きHTMLプレビュー
毎回PDFを出力しなくてよくなり、原稿テキストファイル(.re)を保存するだけで、ある程度似た見た目のHTML出力を出してくれます。
rake web:server
と、一行のコマンドを打つと、サーバーが起動します。その後 localhost:9000
にアクセスすると、原稿のプレビュー(自動更新機能付き)が見れます。
これが本当に便利。2Kのディスプレイと併せると画面の切り替え操作をしなくて良くなるので最高。
(3) VS-Code プラグインがある
Re:Viewは独自の記法を使うのですが、やはり記法にはシンタックスハイライトがあったほうが、視認性が上がるため嬉しいです。
現在、Re:View系のVS-Codeプラグインを検索すると、3つ検索に引っかかります。
- 「Re:View」
- 「yet another Re:View Extension」
- 「Re:View Starter Syntax Highlight」
です。上2つは、反応しないシンタックスがあったりするので、「Re: View Starter Syntax Highlight」を使うことにしました。
その他便利情報
- Re:VIEW Starter ユーザーズガイド
- review/format.ja.md at master · kmuto/review · GitHub
- Re:VIEWチートシート · GitHub
おわりに
技術書じゃなくても、普通にePUB(電子書籍)とかを作りたい人は勉強して損はないと思います。 記法とか使い方は、Notionでまとめながら半日かけたら全部網羅できたので、学習コストもかなり軽いと思います。テクニカルな部分もありますが、それは必要なときに調べればいい感じだと思います。