GitHub Wiki を .wiki.git として Git 管理する方法 - Ryo555-pra/trading-app GitHub Wiki
以下に、GitHub Wiki を .wiki.git
として Git 管理する方法をわかりやすく説明します。
-
あなたのリポジトリ名:
trading-app
-
GitHubユーザー名:
Ryo555-pra
git clone https://github.com/Ryo555-pra/trading-app.wiki.git
cd trading-app.wiki
🔍
.wiki.git
という独立したGitリポジトリとして扱われます(通常のリポジトリとは別物)
touch システム概要.md
touch 環境構築手順.md
touch ローカル開発方法.md
touch データベース設計.md
touch API仕様書.md
touch コーディングルール.md
touch FAQ(よくある質問).md
ファイル名は GitHub Wiki 上で表示されるページ名になります(拡張子は
.md
)
例:Visual Studio Code を使う場合
code .
あとは各 .md
ファイルに、先ほど提供したMarkdownコンテンツをコピペして保存してください。
git add .
git commit -m "初期Wikiページを追加"
git push origin main # ← デフォルトが master の場合もあります
🔄 GitHub Wiki 上にすぐ反映されます!
Home.md
という名前でファイルを作れば、Wikiのトップページになります。
例:
# 📚 Wikiページ一覧
- [[システム概要]]
- [[環境構築手順]]
- [[ローカル開発方法]]
- [[データベース設計]]
- [[API仕様書]]
- [[コーディングルール]]
- [[FAQ(よくある質問)]]
trading-app.wiki/
├── Home.md
├── システム概要.md
├── 環境構築手順.md
├── ローカル開発方法.md
├── データベース設計.md
├── API仕様書.md
├── コーディングルール.md
└── FAQ(よくある質問).md
項目 | 内容 |
---|---|
🔄 Gitで履歴管理 | 誰がいつ何を変更したか記録できる |
📦 Markdownファイルでローカル管理 | ローカルでバックアップ・編集が可能 |
🔁 チームレビューも可能 | PRと連携した運用もできる(GitHub Wiki単体では不可) |
必要であれば .md
ファイルをまとめて生成・zip化してお渡しすることも可能です!ご希望あれば教えてください。