ガイドのカスタマイズ・配布

色々な開発プロジェクトがあるなかで、必ずしも本ガイドどおりに開発するケースは稀です。
そこで本ガイドでは、プロジェクトの様々な特性に合わせて、ガイドを個別にカスタマイズできるようにしています。
さらに、オフライン環境で開発する方向けでも参照できるように、参照時にWEBサーバを必要としないHTMLファイルとして配布可能です。
以下の手順に従ってカスタマイズ・配布してください。

1. カスタマイズ用環境を準備する​

カスタマイズはローカルPC上で行います。 以下手順に従って、カスタマイズ用環境を準備してください。

• ガイドをカスタマイズするには、お使いの環境にて以下のツールが必要です。各ツールをインストールしてください

  • Node.js（v18以上）
    • 実行環境として必要です
  • Visual Studio Code
    • カスタマイズ時のエディタとして推奨します
  • git
    • ガイドのリポジトリをクローンするために必要です

• 本リポジトリをgitでクローンします。ターミナルで以下を実行してください

  git clone https://github.com/Fintan-contents/gai-dev-guide.git
  

• 続いてガイドのライブラリをインストールします。ターミナルで以下を実行してください

  cd gai-dev-guide
  cd website
  npm ci
  

• ガイドの起動します。ターミナルでgai-dev-guide/websiteをカレントディレクトリとして以下を実行してください

  npm start
  

• ブラウザにて、http://localhost:3000にアクセスし、ガイドが表示されれば準備完了です

2. ガイドをカスタマイズする​

• クローンしたリポジトリをVS Codeで開きます
• website/docsディレクトリ配下のmdファイルまたはmdxファイルを編集します
• 編集内容を確認するために、ガイドを再起動します
  ターミナルでgai-dev-guide/websiteをカレントディレクトリとして以下を実行します
  ※編集しながらブラウザ（http://localhost:3000）にて編集内容をリアルタイムで確認可能です

  npm start
  

3. カスタマイズしたガイドを配布する​

開発プロジェクトによって様々な配布方法が考えられますが、ここではオフライン環境で開発する方向けに、ガイドを静的HTMLファイルとして配布する方法を紹介します。

ビルドする​

• ターミナルでgai-dev-guide/websiteをカレントディレクトリとして以下を実行してください。
  この時のnpm scriptはbuildではなくbuild:usableWithoutServerを実行します

  npm run build:usableWithoutServer
  
• website/buildディレクトリ配下に静的HTMLが出力されるので直下のindex.htmlのファイルパスをコピーして、ブラウザにてアクセスして表示されれば出力成功です

ビルドしたガイドを配布する​

• website/buildディレクトリをプロジェクトごとの最適な方法で配布してください
  • 例えば「website/buildディレクトリをZIP圧縮して各人に送付する」や「website/buildディレクトリ資産をファイルサーバに格納する」などが考えられます