Re:VIEW で本や卒論を書いてGitHub ActionsでPDFやePubを生成するテンプレート「ReBook」です。
これで電車の中でも原稿が書けます! たとえばスマホで Git が使えるツール、iPhone/iPad だと Working Copy や、本家GitHubクライアントなどが使えます。
なお拙著「AIとコラボして神絵師になる 論文で読み解くStable Diffusion」(Stable Diffusionの公開から2ヵ月で出版)は Re:VIEWを使って執筆しました。
- 完璧に無料で使える ePub & PDF 生成
- 卒論や技術書典などの技術同人誌に使える
- rubyをインストールしない
- Re:ViewもTeXもインストールしない
- GitHub の Issue や Project を使って校正したり複数人でコラボレーションできる
- GitHub Pages をつかって執筆内容の Webサイト を同時生成する
- GitHub および Actions だけで完結する
- できるだけ覚えることを少なくする(書くことに集中したいから)
- このプロジェクトをクローン、もしくはテンプレートとして新規作成。
- あとは
contents
フォルダにあるsample.re
ファイルを書き換えて - git pushして
- Actionsから眺めていれば、ArtifactsにZIP圧縮された PDF や ePub ファイルが生成されます。
- 章やファイルを増やしたいときは
catalog.yml
を見ましょう - Re:VIEWの書式がわからないときは調べましょう
Jekyllを使ってWebサイトを自動生成して公開します。GitHub PagesによるHTML版の書籍も同時公開できますが、書籍によっては即時公開を望まない場合もあると思います。 GitHub PagesによるWebサイト生成が不要な場合は
.github/workflows/jekyll-gh-pages.yml
を削除してください
多くは config.yml
で指定されているファイルです。
デフォルトは B5 の書籍に設定してありますが、細かい指定も config.yml
で行います。
- coverimage: cover-a5.ai (表紙画像ファイル)
/images/DHP-Metaverse.ai
というファイルになっています。Adobe Illustratorで作成してください(PDF互換形式)。
どうしても入手方法や修正方法がわからない場合は、Re:VIEW Starter で、新規電子書籍プロジェクトを作成してみるとよいと思います。
Re:VIEWを始めやすくするためのスタートラインとしては、kauplanさんの Re:VIEW Starter を参考にしています。
ただし、Re:VIEW Starter では Re:VIEW 3.0 や 4.0 はサポートしていません
と明言されていますので、本プロジェクトでは最新の Re:VIEW 5.5 を使って GitHub Actions でビルドするようにしています。
vvakameさんありがとうございます。
- docker://vvakame/review:5.5
また、GitHub Actions で以下のモジュールを使っています。
- actions/checkout@v3
- actions/upload-artifact@v3
この場をお借りして感謝の意を述べさせていただきます。
テンプレートとして公開しますが、フォークやプルリクエストなど歓迎です。
Happy authoring life!
- 白井暁彦 @o_ob akihiko.shirai.as