さっしーブログ

埼玉県在住のシステムエンジニアです。基本的には技術的な内容を中心に発信していきます。

gitbookを触ってみた

目次

環境

  • Windows10 64bit
  • node.js
  • npm

※Macでもnodeのインストール以外は同様の手順でできるはず。

1.Node.jsをインストールする。

以下のサイトからインストーラーをダウンロードしてインストールを行います。

Node.js

2.gitbookを導入する。

Nodeのインストールが完了してnpmコマンドが使用できる状態になったらnpmコマンドでgitbookのインストールを行います。

2-1.gitbookをインストールする。

npm install gitbook-cli -g

-gをインストールするとグローバル領域にインストールされます。 特に今回は「-g」付ける必要ないけど付けて実施します。

2-2.バージョン確認

インストールされているか確認します。

gitbook --version

3.gitbookを利用する。

ではこれからgitbookを使ってコンテンツを作成していきたいと思います。

3-1.gitbookを初期化する。

まずは作業場所を作成します。 作成したい場所に移動して以下のコマンドで作業ディレクトリを作成します。

mkdir [任意のディレクトリ名]

作業ディレクトリに移動します。

cd [作成した任意のディレクトリ名]

そして最後に以下のコマンドで初期化を行います。

gitbook init

自動生成されたファイルを確認します。

2017/12/27 15:20 <DIR> .
2017/12/27 15:20 <DIR> ..
2017/12/27 15:20 16 README.md
2017/12/27 15:20 40 SUMMARY.md
  2 個のファイル 56 バイト
  2 個のディレクトリ 142,844,104,704 バイトの空き領域

「README.md」「SUMMARY.md」が生成されていれば大丈夫です。

3-2.gitbookのコンテンツをいじってみる。

今回は新規にコンテンツを作成するというようよりかはgitbookを使えるようにするまでを確認したいので 部分的に修正していきます。

以下のファイルの内容を

SUMMARY.md

# Summary

* [Introduction](README.md)

以下のように修正します。

SUMMARY.md

# Summary

* [Introduction](README.md)
  * Hello Workd GitBook

3-3.gitbookをビルドする。

では手を加えたコンテンツをビルドしていきます。

gitbookのルート(「README.md」「SUMMARY.md」がある場所)で下記のコマンドをたたきます。

gitbook build

そうすると、下記のように「_book」というディレクトリが作成されています。 この中に作成したコンテンツのHTMLが生成されます。

2017/12/27 15:37 <DIR> .
2017/12/27 15:37 <DIR> ..
2017/12/27 15:20 16 README.md
2017/12/27 15:20 40 SUMMARY.md
2017/12/27 15:37 <DIR> _book
  2 個のファイル 56 バイト
  3 個のディレクトリ 142,739,230,720 バイトの空き領域

では試しに中を見てみます。

2017/12/27 15:37 <DIR> .
2017/12/27 15:37 <DIR> ..
2017/12/27 15:37 <DIR> gitbook
2017/12/27 15:37 6,045 index.html
2017/12/27 15:37 568 search_index.json
  2 個のファイル 6,613 バイト
  3 個のディレクトリ 142,739,230,720 バイトの空き領域

htmlが生成されていますね。

3-4.gitbookをローカルで確認する。

gitbookは試験用の簡易サーバーを備えているので、これを起動して確認してみる。

以下のコマンドをたたいて、サーバーを起動する。

gitbook serve

以下のURLでアクセスが可能 http://localhost:4000

アクセスすると以下のような画面が表示される。

f:id:y_saiki:20180111234906p:plain

3-5.gitbookをサーバーへデプロイする。

ここはまだ試せていないので今後の課題

結構、有名どこの企業はこれを使って教材を作成しているので自分の会社でも活用できるか検討していきたい。

以上