ドキュメント生成環境構築

前提条件

  1. 共通の環境構築が完了していることを前提とします。
  2. bashが動作するCLIが導入されていることを前提とします。
  3. クローン済みのリポジトリがローカルにあることを前提とします。
  4. 以降の操作はローカルリポジトリのルートディレクトリ上で行います。

プロビジョニングスクリプトの実行

  • プロビジョニングスクリプトを実行すると、自動的にドキュメント生成環境の構築が完了します。
  • 何らかの理由により完了できなかった場合は後述の「手動で環境を構築する」セクションの手順を実行してください。

1.下記コマンドでプロビジョニングスクリプトを実行します。

$ bash provision.sh

手動で環境を構築する

  • このセクションの手順は前述の「プロビジョニングスクリプトの実行」セクションの手順が成功しなかった場合にのみ行ってください。

nodeモジュールのインストール

1.下記コマンドでnodeモジュールのインストールを行います。

$ npm install --save

Gitbookの環境構築

1.Gitbookプラグインのインストールを行います。

$ ./node_modules/.bin/gitbook install

2.最後にビルドを実行して環境構築の完了を確認します。

$ ./node_modules/.bin/gitbook build ./ ./docs

results matching ""

    No results matching ""