しらとりのブログ

社会人ひよこプログラマのtil

社内ドキュメントはgitbookで書こう

共有フォルダにExcelとWordで管理するのがつらすぎるので再考。

gitbook

node.jsで動作するmarkdown→html変換ツール。
じつはあまりgitとは関係がない。

採用例

Djangoの有名チュートリアルのDjango Girls Tutorialで使われているのがgitbookを知ったきっかけ。 基本的に左カラムのメニューからページを選択する。ほぼほぼmarkdownの書式を受け継いでくれる。

使い方

npm install gitbook-cli -g
cd 作業フォルダ
gitbook init

SUMMURY.mdが目次になる。 随時作成したいページごとにmdファイルを作成してSUMMURYに追加する。
できたらビルド。

gitbook build

こうすると_bookフォルダができるのであとはサーバーでこれをホストするだけ。

gitbook serve

これでlocalhostで試験的にサーバーを立てられる。このあとに出てくるURLでページを確認する。

gitbook initしたフォルダをgitで管理してpushをトリガーにしてjenkinsでデプロイできるようにするととても捗ります。 社内ドキュメントはさっさとwebに移行してしまいましょう。