/var/log/messages

debugging with sixth sense

GitBook

ドキュメントを markdown で、って言いつつも見る人どーすんだ、という話があったりしていたのですが、ちょっとこれを使ってみようかな、とか思っていたり。

ちょろっと前に何かのタイミングでチェック入ってはいたのですがスルー状態でした。

その後、Sphinx? とか言ってたりしたのですが、とりあえずこちらを試してみることに。

とりあえず、以下を参考に npm 導入。

これ、追加した apt-line が無効だな。でびあんでは駄目なのかどうか。dpkg で云々なら以下でも良いのかな。

上記リポジトリを clone して

$ cd nodejs-debian
$ bin/make-nodejs-deb.sh 0.10.17

なのかな。て debuild が無いとか言われてるしorz つうかこの端末、debuild はいってないのか。

$ sudo apt-get install devscripts

で、リトライしたら nodejs_0.10.17-1_amd64.deb ができました。導入。

$ sudo dpkg -i nodejs_0.10.17-1_amd64.deb

確認を。

$ which npm
/usr/bin/npm

やれやれ。では gitbook 導入。

$ npm install gitbook -g

あ、sudo が必要なのか。

$ sudo npm install gitbook -g

-g てのはそーゆー意味なのか。で、README.md 一発なディレクトリで早速試してみたのですが

$ gitbook build
Starting build ...
Invalid gitbook repository, need SUMMARY.md and README.md

駄目って言われてしまいました。とりあえず SUMMARY.md 作ってみるか。

適当にでっちあげたら

build が通りました。これ、ファイルを別にすることにも対応しているみたい。別途確認してみたいと思います。

つうか markdown を html に変換して Dropbox とかなナニで共有しつつソースは Git で云々、ってことならこれで良さげな気がしています。

つうかこれ

サイドバーのリンクを見るに Github で云々、が基本になってるみたいですね。

追記

これ、複数ページで、ってナニが可能らしい。最低限 README.md と SUMMARY.md が必要らしいのですが、

  • README.md はインデクスを表示したときのコンテンツ
  • SUMMARY.md はインデクスを表示したときのサイドバーの一部 (INTRODUCTION らしい)

という形になっているのかどうか。

Comments