GitBookを使って社内向けの文章を書く
社内向けのドキュメントを書きたいが、バイナリをGitリポジトリに突っ込んでバージョン管理したくない。 でもバージョン管理はしたいという煩悶を乗り越えるためにGitBook で書いてみました。便利。
GitBookは日本語の記事でもいくつか紹介されています。
GitBookを使うとGitBook.IOに公開しなければビルドできないと思っていたのですが、2つ目の記事にあるようにcliも提供されています。
ローカルでビルドできるのであれば公開したくない文章も書けるし、ちょっと工夫すればPDFやepubもビルドできます。便利。
検証した環境はWindows 8.1 Pro x64です。
インストール
使ってみる
- 適当にディレクトリを掘る
$ mkdir sample-ebook && cd sample-ebook
- とりあえず目次を作る
$ notepad SUMMARY.md
適当に* (Introduction)[README.md]
とかで良い $ gitbook init
でSUMMARY.mdに記述したディレクトリ構造が作成される$ gitbook serve
した後に http://localhost:4000 にアクセスするとビルドしたドキュメントが表示される- PDFやepubにビルドする場合は
$ gitbook pdf
や$ gitbook epub
でOK
これで社内リポジトリにたまっているMarkdownドキュメントも配布しやすい形式にビルドできます。やりましたね:)