Markdown の長文テキストを公開するのに GitBook が良さそう
GitBook という「GitHub のリポジトリにアップした Markdown ファイルを電子書籍風に表示する」的なサービスがある。Markdown で書いたテキスト(特に目次を必須とする長文コンテンツ)を公開する手段として良さそう。
GitBook を試した時のブツ
GitHub - stakiran/test_gitbook ← こんなリポジトリを用意して Push してやると、
↓
Introduction ・ testbook_from_github ← こんな感じで本っぽく表示してくれる
Q: 普通に GitHub のリポジトリで公開するだけじゃダメなの?
A: ダメなことはないが見辛い
目次が自動生成されないし、そもそも UI もデザインもエンジニア向けバージョン管理仕様であるゆえにテキストコンテンツとしては読み辛い。
GitBook なら、左ペインに目次、右ペインに本文、というふうなシンプルな見た目で表示してくれる。
Q: でも GitBook 使うのって難しそうじゃない?
A: 意外とそうでもない
- gitbook.com へのログインは GitHub アカウントでいける
- GitHub リポジトリへの Push が行われたら、併せて GitBook 側でもビルドを走らせる……という Sync 設定ができる
- GitBook 側でビルドさせるために必要な構成は単純で、以下のみ
- 適当な単位で Markdown ファイルを書く
SUMMARY.md
から、書いたファイル達へのリンクを張る(これが目次になる)
その他細かい初期設定は gitbookを試用してみた ・ testbook_from_github に殴り書きした。