ougarairin’s diary

技術的なことと読んだ本とV

gitbook 使用

prog gitbook

背景

前回 gitbook 導入 - ougarairin’s diary にて導入した gitbook を実際に使ってみます. とりあえず動けばよし.

環境 : windows 7 32 ビット

操作方法

  1. フォルダーを作成
    このとき名前は一応半角英数にしておく. (確認してないけどおそらく半角でないと動かない)

  2. コマンドプロンプトを立ち上げ, 作成したフォルダーへ移動

  3. [gitbook init] を実行
    これで作成したフォルダーの中に, 「README.md」「SUMMARY.md」 が作成されているはず

  4. 各々作成したいドキュメントの作成
    詳しい説明はこのあと

  5. [gitbook build] を実行

  6. [gitbook serve] を実行
    これを実行すると http://localhost:4000/ 上に作成した内容をhtmlに変換したものが閲覧できる.
    これを終了する場合には, コマンドプロンプト上で, [Ctrl + C] を押せばOK

  7. PDF 化する場合, [gitbook pdf] を実行
    これを実行してError が発生する場合, おそらく, Calibre をインストールしていないか, PATHを通していない可能性がある.

ドキュメントの作り方

基本的には「.md」ファイルを作成する

  • 「README.md」は Introduce. 表紙にもなる?
  • 「SUMMARY.md」は目次. この中に各々のリンクを貼っておけば, それっぽくよくなる. (説明放棄)
  • 「.md」この拡張子の付くファイルは Markdown 形式にて記述する.

とりあえず以上です.