ドキュメント貢献ガイド

オンライン編集

オンラインでドキュメントを編集するには、オンラインドキュメント左下の このページを編集 をクリックします。ブラウザがリポジトリ内の該当ファイル位置へ移動します。右上の 編集 ボタンをクリックし、変更後にプレビューで確認し、問題がなければ 変更をコミット をクリックして送信します。

送信後はレビューを経て、承認されるとメインリポジトリにマージされます。通常、メインリポジトリにマージされるとオンラインドキュメントは自動更新されます。更新されない場合はページを手動で再読み込みするか、送信後に数分待ってから再読み込みしてください。

ローカル編集

ドキュメントは master ブランチへ直接 PR を送信 できます。機能ブランチを作成する必要はありません。

コードを送信する前に、ローカルで Git のグローバル設定が完了していることを確認してください。

git config --global user.name あなたの Git ユーザー名
git config --global user.email あなたのコミット用メールアドレス（コードプラットフォームのアカウントメールと一致している必要があります）

1. プロジェクトを Fork：右上の Fork をクリックして自分のリポジトリにコピーします
2. リポジトリをクローン：git clone
3. ドキュメントを編集：docs ディレクトリ内で変更したいファイルを探し、Markdown 構文で編集します（Markdown 構文 を参照）
4. 変更をコミット：git commit -m "ドキュメント変更の説明"
5. ブランチをプッシュ：git push origin master

送信後、自分が fork したリポジトリのページで Pull Request ボタンをクリックし、PR を作成します。

Konado ドキュメントのローカルプレビュー

Konado ドキュメントは VitePress で構築されています。変更内容が期待どおりに表示されることを確認するため、コードを送信する前にローカルでプレビューすることを推奨します。

事前準備：Node.js のインストール

VitePress は Node.js 環境で動作するため、対応する Node.js を先にインストールする必要があります。

1. バージョン要件：Node.js 18.x 以上を推奨します。互換性の面では LTS版が最適です。
2. ダウンロードとインストール：
   • Node.js 公式ダウンロードページにアクセスします：https://nodejs.org/
   • 使用している OS（Windows/macOS/Linux）に合うインストーラーを選び、ウィザードに従ってインストールします（Windows では「Add to PATH」の選択を推奨します）。
3. インストール確認： ターミナル（Windows はコマンドプロンプト/PowerShell、macOS/Linux はターミナル）を開き、以下のコマンドで Node.js と npm（Node.js に同梱されるパッケージマネージャー）が正常にインストールされたか確認します。

   # Node.js のバージョンを確認
   node -v
   # npm のバージョンを確認
   npm -v

   v20.10.0 や 10.2.3 のような明確なバージョン番号が表示されれば、インストールは成功です。

任意の最適化：npm の依存関係ダウンロードが遅い場合は、中国国内ミラーを設定して速度を改善できます。

npm config set registry https://registry.npmmirror.com

プロジェクト依存関係のインストール

Konado プロジェクトのルートディレクトリに移動し、以下のコマンドでドキュメントプレビューに必要な依存関係をインストールします。

npm install

コマンドが完了し、ターミナルにエラーが表示されなければ依存関係のインストールは成功です。

ローカルプレビューサーバーの起動

依存関係のインストール後、以下のコマンドで VitePress 開発サーバーを起動します。

npm run docs:dev

プレビュードキュメントへのアクセス

コマンドが正常に実行されると、ターミナルに以下のような情報が表示されます。

vitepress v1.6.4

➜  Local:   http://localhost:5173/konado/
➜  Network: use --host to expose
➜  press h to show help

ブラウザを開き、出力された Local アドレス（通常は http://localhost:5173/konado/）にアクセスすると、ローカルドキュメントを確認できます。

補足

1. ライブリロード：ドキュメントを変更してもサービスを再起動する必要はありません。ブラウザが自動的に再読み込みされ、変更後の結果がリアルタイムに表示されます。
2. ポートの問題：localhost:5173 ポートが使用中の場合、VitePress は 5174 など利用可能なポートへ自動的に切り替えます。ターミナルに表示された実際のアドレスを使用してください。
3. LAN アクセス：スマートフォンや別の PC など、同じ LAN 内の他のデバイスからプレビューしたい場合は、npm run docs:dev -- --host を実行します。ターミナルにネットワークからアクセス可能な IP アドレスが表示されます。
4. サーバー停止：ターミナルで Ctrl + C を押すと、ローカルプレビューサーバーを停止できます。