【簡単導入】GitBook導入方法-Markdownでドキュメントを残そう!

トップ> プログラム> 技術系ブログ> 【簡単導入】GitBook導入方法-Markdownでドキュメントを残そう!

ドキュメントを残す

最近、Markdownというものを知りまして、これでドキュメントを残してみようという試みをしています。
ただ残すだけでは意味がないので、ドキュメントを見る方法も探しました。

結局、MarkdownはHTMLへの変換を行って、ブログやサイトみたいに公開すると、社内文書としても誰でも見やすいというお話です。

それでは、最適なツール「GitBook」の導入方法を紹介します!

GitBookの導入方法

1.Node.jsをインストールする
GitBookを入れるためには、Node.jsが必要となります。ホームページからダウンロードしてインストールしてください。

Node.jsサイト

2.GitBookのインストール
コマンドプロンプトを起動して、以下のコマンドを実行します。

npm install gitbook-cli -g

3.ディレクトリの移動
インストールが終わったら、GitBookのプロジェクトを作成したいフォルダに、cdコマンドを利用して移動します。

cd 任意のフォルダ

4.GitBookのプロジェクト作成(初期構築)
プロジェクトを作成し、準備を整えます。以下のコマンドを実行します。

gitbook init

コマンドを実行すると、フォルダ内に「README.md」「SUMMARY.md」の二つのファイルが作成されます。

5.「book.json」ファイルの作成
mdファイルをhtml変換するにあたって、必要な設定などを記入するjsonファイルを作成します。
ひとまず、日本語設定を書き込んでおきましょう。

{
    "language": "ja"
}

6.仮サーバーで動かしてみる
ここまで設定が出来たら、動かしてみましょう。以下のコマンドを実行してください。

gitbook serve

URLが出てくるので、ブラウザでアクセスしてみましょう。
URL:http://localhost:4000

【アクセスするとIntoroductionのページが表示される】

仮サーバーを停止させる場合は、コマンドプロンプトで「Ctrl + C」を押してください。

7.ビルドする
最終的にサイトを利用できるようにするには、ビルドしておくと良いでしょう。

gitbook build

プラグインの設定

プラグインを導入することで、便利な機能を多数利用することが出来ます。
プラグインの設定は、以下のように「book.json」ファイルに設定します。

{
     "language": "ja"

    ,"plugins": [
            "-sharing"
           ,"hide-published-with"
           ,"collapsible-chapters"
     ]
}

上記のプラグインの内容
・SNSシェアボタンを消す
・GitBook投稿ボタンを消す
・折り畳みのサイドの目次

「book.json」ファイルに設定が終わったら、コマンドプロンプトで以下のコマンドを実行し、プラグインのインストールを行ってから動作させてみましょう。

gitbook install

inserted by FC2 system