@k2works/claude-code-booster 1.9.0 → 1.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (94) hide show
  1. package/LICENSE +21 -21
  2. package/README.md +42 -42
  3. package/bin/claude-code-booster +79 -79
  4. package/lib/assets/.claude/README.md +162 -162
  5. package/lib/assets/.claude/SKILLS_TEMPLATE.md +100 -100
  6. package/lib/assets/.claude/scripts/generate-inception-deck.mjs +911 -1024
  7. package/lib/assets/.claude/settings.json +11 -11
  8. package/lib/assets/.claude/skills/ai-agent-guidelines/SKILL.md +119 -119
  9. package/lib/assets/.claude/skills/analyzing-architecture/SKILL.md +87 -87
  10. package/lib/assets/.claude/skills/analyzing-business/SKILL.md +117 -117
  11. package/lib/assets/.claude/skills/analyzing-data-model/SKILL.md +80 -80
  12. package/lib/assets/.claude/skills/analyzing-domain-model/SKILL.md +88 -88
  13. package/lib/assets/.claude/skills/analyzing-inception-deck/SKILL.md +137 -137
  14. package/lib/assets/.claude/skills/analyzing-non-functional/SKILL.md +91 -91
  15. package/lib/assets/.claude/skills/analyzing-operation/SKILL.md +91 -91
  16. package/lib/assets/.claude/skills/analyzing-requirements/SKILL.md +87 -87
  17. package/lib/assets/.claude/skills/analyzing-tech-stack/SKILL.md +102 -102
  18. package/lib/assets/.claude/skills/analyzing-test-strategy/SKILL.md +87 -87
  19. package/lib/assets/.claude/skills/analyzing-ui-design/SKILL.md +86 -86
  20. package/lib/assets/.claude/skills/analyzing-usecases/SKILL.md +87 -87
  21. package/lib/assets/.claude/skills/creating-adr/SKILL.md +115 -115
  22. package/lib/assets/.claude/skills/developing-backend/SKILL.md +106 -106
  23. package/lib/assets/.claude/skills/developing-frontend/SKILL.md +96 -96
  24. package/lib/assets/.claude/skills/developing-release/SKILL.md +154 -154
  25. package/lib/assets/.claude/skills/generating-slides/SKILL.md +136 -106
  26. package/lib/assets/.claude/skills/git-commit/SKILL.md +106 -106
  27. package/lib/assets/.claude/skills/killing-processes/SKILL.md +98 -98
  28. package/lib/assets/.claude/skills/managing-docs/SKILL.md +200 -200
  29. package/lib/assets/.claude/skills/managing-operations/DEPLOY.md +77 -77
  30. package/lib/assets/.claude/skills/managing-operations/SETUP_CSHARP.md +80 -80
  31. package/lib/assets/.claude/skills/managing-operations/SETUP_FRONTEND.md +84 -84
  32. package/lib/assets/.claude/skills/managing-operations/SETUP_JAVA.md +75 -75
  33. package/lib/assets/.claude/skills/managing-operations/SKILL.md +156 -156
  34. package/lib/assets/.claude/skills/orchestrating-analysis/SKILL.md +134 -134
  35. package/lib/assets/.claude/skills/orchestrating-development/SKILL.md +243 -243
  36. package/lib/assets/.claude/skills/orchestrating-project/SKILL.md +193 -193
  37. package/lib/assets/.claude/skills/planning-releases/SKILL.md +222 -222
  38. package/lib/assets/.claude/skills/syncing-github-project/SKILL.md +181 -69
  39. package/lib/assets/.claude/skills/tracking-progress/SKILL.md +164 -164
  40. package/lib/assets/.devcontainer/devcontainer.json +34 -34
  41. package/lib/assets/.env.example +17 -17
  42. package/lib/assets/.gitattributes +4 -4
  43. package/lib/assets/.github/workflows/docker-publish.yml +77 -77
  44. package/lib/assets/.github/workflows/mkdocs.yml +39 -39
  45. package/lib/assets/AGENTS.md +94 -94
  46. package/lib/assets/CLAUDE.md +162 -162
  47. package/lib/assets/README.md +269 -269
  48. package/lib/assets/docker-compose.yml +33 -33
  49. package/lib/assets/docs/assets/css/extra.css +29 -29
  50. package/lib/assets/docs/assets/js/extra.js +44 -44
  51. package/lib/assets/docs/index.md +14 -14
  52. package/lib/assets/docs/reference/CodexCLIMCP/343/202/242/343/203/227/343/203/252/343/202/261/343/203/274/343/202/267/343/203/247/343/203/263/351/226/213/347/231/272/343/203/225/343/203/255/343/203/274.md +532 -532
  53. package/lib/assets/docs/reference/CodexCLIMCP/343/202/265/343/203/274/343/203/220/343/203/274/350/250/255/345/256/232/346/211/213/351/240/206.md +341 -341
  54. package/lib/assets/docs/reference/Java/343/202/242/343/203/227/343/203/252/343/202/261/343/203/274/343/202/267/343/203/247/343/203/263/347/222/260/345/242/203/346/247/213/347/257/211/343/202/254/343/202/244/343/203/211.md +578 -578
  55. package/lib/assets/docs/reference/TypeScript/343/202/242/343/203/227/343/203/252/343/202/261/343/203/274/343/202/267/343/203/247/343/203/263/347/222/260/345/242/203/346/247/213/347/257/211/343/202/254/343/202/244/343/203/211.md +465 -465
  56. package/lib/assets/docs/reference/UI/350/250/255/350/250/210/343/202/254/343/202/244/343/203/211.md +448 -448
  57. package/lib/assets/docs/reference//343/202/210/343/201/204/343/202/275/343/203/225/343/203/210/343/202/246/343/202/247/343/202/242/343/201/250/343/201/257.md +242 -242
  58. package/lib/assets/docs/reference//343/202/242/343/203/274/343/202/255/343/203/206/343/202/257/343/203/201/343/203/243/350/250/255/350/250/210/343/202/254/343/202/244/343/203/211.md +2216 -2216
  59. package/lib/assets/docs/reference//343/202/244/343/203/263/343/203/225/343/203/251/350/250/255/350/250/210/343/202/254/343/202/244/343/203/211.md +1878 -1878
  60. package/lib/assets/docs/reference//343/202/250/343/202/257/343/202/271/343/203/210/343/203/252/343/203/274/343/203/240/343/203/227/343/203/255/343/202/260/343/203/251/343/203/237/343/203/263/343/202/260.md +554 -554
  61. package/lib/assets/docs/reference//343/202/263/343/203/274/343/203/207/343/202/243/343/203/263/343/202/260/343/201/250/343/203/206/343/202/271/343/203/210/343/202/254/343/202/244/343/203/211.md +705 -705
  62. package/lib/assets/docs/reference//343/203/206/343/202/271/343/203/210/346/210/246/347/225/245/343/202/254/343/202/244/343/203/211.md +1313 -1313
  63. package/lib/assets/docs/reference//343/203/207/343/203/274/343/202/277/343/203/242/343/203/207/343/203/253/350/250/255/350/250/210/343/202/254/343/202/244/343/203/211.md +311 -311
  64. package/lib/assets/docs/reference//343/203/211/343/203/241/343/202/244/343/203/263/343/203/242/343/203/207/343/203/253/350/250/255/350/250/210/343/202/254/343/202/244/343/203/211.md +599 -599
  65. package/lib/assets/docs/reference//343/203/223/343/202/270/343/203/215/343/202/271/343/202/242/343/203/274/343/202/255/343/203/206/343/202/257/343/203/201/343/203/243/345/210/206/346/236/220/343/202/254/343/202/244/343/203/211.md +528 -528
  66. package/lib/assets/docs/reference//343/203/246/343/203/274/343/202/271/343/202/261/343/203/274/343/202/271/344/275/234/346/210/220/343/202/254/343/202/244/343/203/211.md +682 -682
  67. package/lib/assets/docs/reference//343/203/252/343/203/252/343/203/274/343/202/271/343/202/254/343/202/244/343/203/211.md +442 -442
  68. package/lib/assets/docs/reference//343/203/252/343/203/252/343/203/274/343/202/271/343/203/273/343/202/244/343/203/206/343/203/254/343/203/274/343/202/267/343/203/247/343/203/263/350/250/210/347/224/273/343/202/254/343/202/244/343/203/211.md +558 -558
  69. package/lib/assets/docs/reference//347/222/260/345/242/203/345/244/211/346/225/260/347/256/241/347/220/206/343/202/254/343/202/244/343/203/211.md +663 -663
  70. package/lib/assets/docs/reference//350/246/201/344/273/266/345/256/232/347/276/251/343/202/254/343/202/244/343/203/211.md +1248 -1248
  71. package/lib/assets/docs/reference//351/201/213/347/224/250/350/246/201/344/273/266/345/256/232/347/276/251/343/202/254/343/202/244/343/203/211.md +392 -392
  72. package/lib/assets/docs/reference//351/226/213/347/231/272/343/202/254/343/202/244/343/203/211.md +235 -235
  73. package/lib/assets/docs/reference//351/235/236/346/251/237/350/203/275/350/246/201/344/273/266/345/256/232/347/276/251/343/202/254/343/202/244/343/203/211.md +1236 -1236
  74. package/lib/assets/docs/template/ADR.md +30 -30
  75. package/lib/assets/docs/template/README.md +50 -50
  76. package/lib/assets/docs/template//343/201/276/343/201/232/343/201/223/343/202/214/343/202/222/350/252/255/343/202/202/343/201/206/343/203/252/343/202/271/343/203/210.md +12 -12
  77. package/lib/assets/docs/template//343/202/244/343/203/206/343/203/254/343/203/274/343/202/267/343/203/247/343/203/263/345/256/214/344/272/206/345/240/261/345/221/212/346/233/270.md +58 -58
  78. package/lib/assets/docs/template//343/202/244/343/203/263/343/202/273/343/203/227/343/202/267/343/203/247/343/203/263/343/203/207/343/203/203/343/202/255.md +13 -13
  79. package/lib/assets/docs/template//343/203/223/343/202/270/343/203/215/343/202/271/343/202/242/343/203/274/343/202/255/343/203/206/343/202/257/343/203/201/343/203/243.md +379 -379
  80. package/lib/assets/docs/template//345/256/214/345/205/250/345/275/242/345/274/217/343/201/256/343/203/246/343/203/274/343/202/271/343/202/261/343/203/274/343/202/271.md +68 -68
  81. package/lib/assets/docs/template//350/246/201/344/273/266/345/256/232/347/276/251.md +669 -669
  82. package/lib/assets/docs/template//350/250/255/350/250/210.md +163 -163
  83. package/lib/assets/gulpfile.js +23 -23
  84. package/lib/assets/mkdocs.yml +65 -65
  85. package/lib/assets/ops/docker/mkdoc/Dockerfile +19 -19
  86. package/lib/assets/ops/scripts/journal.js +180 -180
  87. package/lib/assets/ops/scripts/mkdocs.js +82 -82
  88. package/lib/assets/ops/scripts/release.js +431 -431
  89. package/lib/assets/ops/scripts/ssh.js +190 -190
  90. package/lib/assets/ops/scripts/vault.js +299 -299
  91. package/lib/assets/package-lock.json +1653 -1653
  92. package/lib/assets/package.json +40 -40
  93. package/lib/gulpfile.js +37 -37
  94. package/package.json +41 -41
@@ -1,269 +1,269 @@
1
- # {project-name}
2
-
3
- ## 概要
4
-
5
- ### 目的
6
-
7
- ### 前提
8
-
9
- | ソフトウェア | バージョン | 備考 |
10
- | :----------- | :--------- | :--- |
11
- | nodejs | 22.x | |
12
-
13
- ## 構成
14
-
15
- - [構築](#構築)
16
- - [配置](#配置)
17
- - [運用](#運用)
18
- - [開発](#開発)
19
-
20
- ## 詳細
21
-
22
- ### Quick Start
23
-
24
- ```bash
25
- npm install
26
- npm start
27
- ```
28
-
29
- ### 構築
30
-
31
- ```bash
32
- claude mcp add -s project memory -- npx @modelcontextprotocol/server-memory
33
- claude mcp add -s project codex -- npx @openai/codex mcp-server
34
- ```
35
-
36
- #### AI アシスタント(Skills)
37
-
38
- `.claude/skills/` ディレクトリに定義された Skills により、AI アシスタントがタスクに応じた専門的な指示を自動的に読み込みます。Progressive Disclosure(段階的開示)により、必要なスキルのみがコンテキストに展開されます。
39
-
40
- ##### Skills 一覧
41
-
42
- | カテゴリ | スキル | 説明 |
43
- | :--- | :--- | :--- |
44
- | **オーケストレーション** | `orchestrating-analysis` | 分析フェーズ全体のワークフロー案内 |
45
- | | `orchestrating-development` | 開発フェーズ全体の TDD ワークフロー案内 |
46
- | | `orchestrating-project` | 計画・進捗管理フェーズ全体のワークフロー案内 |
47
- | **分析** | `analyzing-business` | ビジネスアーキテクチャ分析 |
48
- | | `analyzing-requirements` | RDRA 2.0 に基づく要件定義 |
49
- | | `analyzing-usecases` | ユースケース・ユーザーストーリー作成 |
50
- | | `analyzing-architecture` | アーキテクチャ設計 |
51
- | | `analyzing-data-model` | データモデル設計 |
52
- | | `analyzing-domain-model` | ドメインモデル設計 |
53
- | | `analyzing-ui-design` | UI 設計 |
54
- | | `analyzing-tech-stack` | 技術スタック選定 |
55
- | | `analyzing-test-strategy` | テスト戦略策定 |
56
- | | `analyzing-non-functional` | 非機能要件定義 |
57
- | | `analyzing-operation` | 運用要件定義 |
58
- | **開発** | `developing-backend` | バックエンド TDD(インサイドアウト) |
59
- | | `developing-frontend` | フロントエンド TDD(アウトサイドイン) |
60
- | | `developing-release` | リリースワークフロー(品質ゲート・バージョン管理・CHANGELOG) |
61
- | **計画・進捗** | `planning-releases` | リリース・イテレーション計画 |
62
- | | `syncing-github-project` | GitHub Project 同期 |
63
- | | `tracking-progress` | 進捗分析・レポート生成 |
64
- | **運用** | `managing-operations` | 環境構築・デプロイ・監視 |
65
- | | `killing-processes` | 開発プロセス強制終了 |
66
- | **ドキュメント・Git** | `managing-docs` | ドキュメント管理・Lint |
67
- | | `git-commit` | Conventional Commits 準拠のコミット |
68
- | | `creating-adr` | ADR 作成 |
69
- | **共通** | `ai-agent-guidelines` | AI Agent 実行ガイドライン |
70
-
71
- ##### カスタマイズ
72
-
73
- 新しいスキルを追加するには、`.claude/skills/<skill-name>/SKILL.md` を作成します。テンプレートは `.claude/SKILLS_TEMPLATE.md` を参照してください。
74
-
75
- **[⬆ back to top](#構成)**
76
-
77
- ### 配置
78
-
79
- #### GitHub Pages セットアップ
80
-
81
- 1. **GitHub リポジトリの Settings を開く**
82
- - リポジトリページで `Settings` タブをクリック
83
-
84
- 2. **Pages 設定を開く**
85
- - 左サイドバーの `Pages` をクリック
86
-
87
- 3. **Source を設定**
88
- - `Source` で `Deploy from a branch` を選択
89
- - `Branch` で `gh-pages` を選択し、フォルダは `/ (root)` を選択
90
- - `Save` をクリック
91
-
92
- 4. **初回デプロイ**
93
- - main ブランチにプッシュすると GitHub Actions が自動実行
94
- - Actions タブでデプロイ状況を確認
95
-
96
- **[⬆ back to top](#構成)**
97
-
98
- ### 運用
99
-
100
- #### ドキュメントの編集
101
-
102
- 1. ローカル環境でMkDocsサーバーを起動
103
- ```
104
- docker-compose up mkdocs
105
- ```
106
- または、Gulpタスクを使用:
107
- ```
108
- npm run docs:serve
109
- ```
110
-
111
- 2. ブラウザで http://localhost:8000 にアクセスして編集結果をプレビュー
112
-
113
- 3. `docs/`ディレクトリ内のMarkdownファイルを編集
114
-
115
- 4. 変更をコミットしてプッシュ
116
- ```
117
- git add .
118
- git commit -m "ドキュメントの更新"
119
- git push
120
- ```
121
-
122
- #### Gulpタスクの使用
123
-
124
- プロジェクトには以下のGulpタスクが用意されています:
125
-
126
- ##### MkDocsタスク
127
-
128
- - MkDocsサーバーの起動:
129
- ```
130
- npm run docs:serve
131
- ```
132
- または
133
- ```
134
- npx gulp mkdocs:serve
135
- ```
136
-
137
- - MkDocsサーバーの停止:
138
- ```
139
- npm run docs:stop
140
- ```
141
- または
142
- ```
143
- npx gulp mkdocs:stop
144
- ```
145
-
146
- - MkDocsドキュメントのビルド:
147
- ```
148
- npm run docs:build
149
- ```
150
- または
151
- ```
152
- npx gulp mkdocs:build
153
- ```
154
-
155
- ##### 作業履歴(ジャーナル)タスク
156
-
157
- - すべてのコミット日付の作業履歴を生成:
158
- ```
159
- npm run journal
160
- ```
161
- または
162
- ```
163
- npx gulp journal:generate
164
- ```
165
-
166
- - 特定の日付の作業履歴を生成:
167
- ```
168
- npx gulp journal:generate:date --date=YYYY-MM-DD
169
- ```
170
- (例: `npx gulp journal:generate:date --date=2023-04-01`)
171
-
172
- 生成された作業履歴は `docs/journal/` ディレクトリに保存され、各ファイルには指定された日付のコミット情報が含まれます。
173
-
174
- #### GitHub Container Registry
175
-
176
- このプロジェクトでは、GitHub Container Registry(GHCR)を使用して開発コンテナイメージを管理しています。
177
-
178
- ##### 自動ビルド・プッシュ
179
-
180
- タグをプッシュすると、GitHub Actions が自動的にコンテナイメージをビルドし、GHCR にプッシュします。
181
-
182
- ```bash
183
- # タグを作成してプッシュ
184
- git tag 0.0.1
185
- git push origin 0.0.1
186
- ```
187
-
188
- ##### イメージの取得・実行
189
-
190
- GHCR からイメージを取得して実行するには:
191
-
192
- ```bash
193
- # イメージをプル
194
- docker pull ghcr.io/k2works/{project_name}:latest
195
-
196
- # または特定バージョン
197
- docker pull ghcr.io/k2works/{project_name}:0.0.1
198
-
199
- # コンテナを実行
200
- docker run -it -v $(pwd):/srv ghcr.io/k2works/{project_name}:latest
201
- ```
202
-
203
- または、docker-compose を使用してローカルでビルド・実行することもできます:
204
-
205
- ```bash
206
- # 開発環境を起動して中に入る
207
- docker-compose run --rm dev bash
208
- ```
209
-
210
- 認証が必要な場合は、以下のコマンドでログインします:
211
-
212
- ```bash
213
- # GitHub Personal Access Token でログイン
214
- echo $GITHUB_TOKEN | docker login ghcr.io -u <username> --password-stdin
215
- ```
216
-
217
- ##### 権限設定
218
-
219
- - リポジトリの Settings → Actions → General で `Read and write permissions` を設定
220
- - `GITHUB_TOKEN` に `packages: write` 権限が付与されています
221
-
222
- ##### Dev Container の使用
223
-
224
- VS Code で Dev Container を使用する場合:
225
-
226
- 1. VS Code で「Dev Containers: Reopen in Container」を実行
227
- 2. または「Dev Containers: Rebuild and Reopen in Container」で再ビルド
228
-
229
- **[⬆ back to top](#構成)**
230
-
231
- ### 開発
232
-
233
- #### Nix による開発環境
234
-
235
- Nix を使用して、再現可能な開発環境を構築できます。
236
-
237
- ##### 準備
238
-
239
- 1. [Nix をインストール](https://nixos.org/download.html)します。
240
- 2. Flakes を有効にします(`~/.config/nix/nix.conf` に `experimental-features = nix-command flakes` を追加)。
241
-
242
- ##### 環境の利用
243
-
244
- - **デフォルト環境(共通ツール)に入る:**
245
- ```bash
246
- nix develop
247
- ```
248
-
249
- - **Node.js 環境に入る:**
250
- ```bash
251
- nix develop .#node
252
- ```
253
-
254
- - **Python/MkDocs 環境に入る:**
255
- ```bash
256
- nix develop .#python
257
- ```
258
-
259
- 環境から抜けるには `exit` を入力します。
260
-
261
- ##### 依存関係の更新
262
-
263
- ```bash
264
- nix flake update
265
- ```
266
-
267
- **[⬆ back to top](#構成)**
268
-
269
- ## 参照
1
+ # {project-name}
2
+
3
+ ## 概要
4
+
5
+ ### 目的
6
+
7
+ ### 前提
8
+
9
+ | ソフトウェア | バージョン | 備考 |
10
+ | :----------- | :--------- | :--- |
11
+ | nodejs | 22.x | |
12
+
13
+ ## 構成
14
+
15
+ - [構築](#構築)
16
+ - [配置](#配置)
17
+ - [運用](#運用)
18
+ - [開発](#開発)
19
+
20
+ ## 詳細
21
+
22
+ ### Quick Start
23
+
24
+ ```bash
25
+ npm install
26
+ npm start
27
+ ```
28
+
29
+ ### 構築
30
+
31
+ ```bash
32
+ claude mcp add -s project memory -- npx @modelcontextprotocol/server-memory
33
+ claude mcp add -s project codex -- npx @openai/codex mcp-server
34
+ ```
35
+
36
+ #### AI アシスタント(Skills)
37
+
38
+ `.claude/skills/` ディレクトリに定義された Skills により、AI アシスタントがタスクに応じた専門的な指示を自動的に読み込みます。Progressive Disclosure(段階的開示)により、必要なスキルのみがコンテキストに展開されます。
39
+
40
+ ##### Skills 一覧
41
+
42
+ | カテゴリ | スキル | 説明 |
43
+ | :--- | :--- | :--- |
44
+ | **オーケストレーション** | `orchestrating-analysis` | 分析フェーズ全体のワークフロー案内 |
45
+ | | `orchestrating-development` | 開発フェーズ全体の TDD ワークフロー案内 |
46
+ | | `orchestrating-project` | 計画・進捗管理フェーズ全体のワークフロー案内 |
47
+ | **分析** | `analyzing-business` | ビジネスアーキテクチャ分析 |
48
+ | | `analyzing-requirements` | RDRA 2.0 に基づく要件定義 |
49
+ | | `analyzing-usecases` | ユースケース・ユーザーストーリー作成 |
50
+ | | `analyzing-architecture` | アーキテクチャ設計 |
51
+ | | `analyzing-data-model` | データモデル設計 |
52
+ | | `analyzing-domain-model` | ドメインモデル設計 |
53
+ | | `analyzing-ui-design` | UI 設計 |
54
+ | | `analyzing-tech-stack` | 技術スタック選定 |
55
+ | | `analyzing-test-strategy` | テスト戦略策定 |
56
+ | | `analyzing-non-functional` | 非機能要件定義 |
57
+ | | `analyzing-operation` | 運用要件定義 |
58
+ | **開発** | `developing-backend` | バックエンド TDD(インサイドアウト) |
59
+ | | `developing-frontend` | フロントエンド TDD(アウトサイドイン) |
60
+ | | `developing-release` | リリースワークフロー(品質ゲート・バージョン管理・CHANGELOG) |
61
+ | **計画・進捗** | `planning-releases` | リリース・イテレーション計画 |
62
+ | | `syncing-github-project` | GitHub Project 同期 |
63
+ | | `tracking-progress` | 進捗分析・レポート生成 |
64
+ | **運用** | `managing-operations` | 環境構築・デプロイ・監視 |
65
+ | | `killing-processes` | 開発プロセス強制終了 |
66
+ | **ドキュメント・Git** | `managing-docs` | ドキュメント管理・Lint |
67
+ | | `git-commit` | Conventional Commits 準拠のコミット |
68
+ | | `creating-adr` | ADR 作成 |
69
+ | **共通** | `ai-agent-guidelines` | AI Agent 実行ガイドライン |
70
+
71
+ ##### カスタマイズ
72
+
73
+ 新しいスキルを追加するには、`.claude/skills/<skill-name>/SKILL.md` を作成します。テンプレートは `.claude/SKILLS_TEMPLATE.md` を参照してください。
74
+
75
+ **[⬆ back to top](#構成)**
76
+
77
+ ### 配置
78
+
79
+ #### GitHub Pages セットアップ
80
+
81
+ 1. **GitHub リポジトリの Settings を開く**
82
+ - リポジトリページで `Settings` タブをクリック
83
+
84
+ 2. **Pages 設定を開く**
85
+ - 左サイドバーの `Pages` をクリック
86
+
87
+ 3. **Source を設定**
88
+ - `Source` で `Deploy from a branch` を選択
89
+ - `Branch` で `gh-pages` を選択し、フォルダは `/ (root)` を選択
90
+ - `Save` をクリック
91
+
92
+ 4. **初回デプロイ**
93
+ - main ブランチにプッシュすると GitHub Actions が自動実行
94
+ - Actions タブでデプロイ状況を確認
95
+
96
+ **[⬆ back to top](#構成)**
97
+
98
+ ### 運用
99
+
100
+ #### ドキュメントの編集
101
+
102
+ 1. ローカル環境でMkDocsサーバーを起動
103
+ ```
104
+ docker-compose up mkdocs
105
+ ```
106
+ または、Gulpタスクを使用:
107
+ ```
108
+ npm run docs:serve
109
+ ```
110
+
111
+ 2. ブラウザで http://localhost:8000 にアクセスして編集結果をプレビュー
112
+
113
+ 3. `docs/`ディレクトリ内のMarkdownファイルを編集
114
+
115
+ 4. 変更をコミットしてプッシュ
116
+ ```
117
+ git add .
118
+ git commit -m "ドキュメントの更新"
119
+ git push
120
+ ```
121
+
122
+ #### Gulpタスクの使用
123
+
124
+ プロジェクトには以下のGulpタスクが用意されています:
125
+
126
+ ##### MkDocsタスク
127
+
128
+ - MkDocsサーバーの起動:
129
+ ```
130
+ npm run docs:serve
131
+ ```
132
+ または
133
+ ```
134
+ npx gulp mkdocs:serve
135
+ ```
136
+
137
+ - MkDocsサーバーの停止:
138
+ ```
139
+ npm run docs:stop
140
+ ```
141
+ または
142
+ ```
143
+ npx gulp mkdocs:stop
144
+ ```
145
+
146
+ - MkDocsドキュメントのビルド:
147
+ ```
148
+ npm run docs:build
149
+ ```
150
+ または
151
+ ```
152
+ npx gulp mkdocs:build
153
+ ```
154
+
155
+ ##### 作業履歴(ジャーナル)タスク
156
+
157
+ - すべてのコミット日付の作業履歴を生成:
158
+ ```
159
+ npm run journal
160
+ ```
161
+ または
162
+ ```
163
+ npx gulp journal:generate
164
+ ```
165
+
166
+ - 特定の日付の作業履歴を生成:
167
+ ```
168
+ npx gulp journal:generate:date --date=YYYY-MM-DD
169
+ ```
170
+ (例: `npx gulp journal:generate:date --date=2023-04-01`)
171
+
172
+ 生成された作業履歴は `docs/journal/` ディレクトリに保存され、各ファイルには指定された日付のコミット情報が含まれます。
173
+
174
+ #### GitHub Container Registry
175
+
176
+ このプロジェクトでは、GitHub Container Registry(GHCR)を使用して開発コンテナイメージを管理しています。
177
+
178
+ ##### 自動ビルド・プッシュ
179
+
180
+ タグをプッシュすると、GitHub Actions が自動的にコンテナイメージをビルドし、GHCR にプッシュします。
181
+
182
+ ```bash
183
+ # タグを作成してプッシュ
184
+ git tag 0.0.1
185
+ git push origin 0.0.1
186
+ ```
187
+
188
+ ##### イメージの取得・実行
189
+
190
+ GHCR からイメージを取得して実行するには:
191
+
192
+ ```bash
193
+ # イメージをプル
194
+ docker pull ghcr.io/k2works/{project_name}:latest
195
+
196
+ # または特定バージョン
197
+ docker pull ghcr.io/k2works/{project_name}:0.0.1
198
+
199
+ # コンテナを実行
200
+ docker run -it -v $(pwd):/srv ghcr.io/k2works/{project_name}:latest
201
+ ```
202
+
203
+ または、docker-compose を使用してローカルでビルド・実行することもできます:
204
+
205
+ ```bash
206
+ # 開発環境を起動して中に入る
207
+ docker-compose run --rm dev bash
208
+ ```
209
+
210
+ 認証が必要な場合は、以下のコマンドでログインします:
211
+
212
+ ```bash
213
+ # GitHub Personal Access Token でログイン
214
+ echo $GITHUB_TOKEN | docker login ghcr.io -u <username> --password-stdin
215
+ ```
216
+
217
+ ##### 権限設定
218
+
219
+ - リポジトリの Settings → Actions → General で `Read and write permissions` を設定
220
+ - `GITHUB_TOKEN` に `packages: write` 権限が付与されています
221
+
222
+ ##### Dev Container の使用
223
+
224
+ VS Code で Dev Container を使用する場合:
225
+
226
+ 1. VS Code で「Dev Containers: Reopen in Container」を実行
227
+ 2. または「Dev Containers: Rebuild and Reopen in Container」で再ビルド
228
+
229
+ **[⬆ back to top](#構成)**
230
+
231
+ ### 開発
232
+
233
+ #### Nix による開発環境
234
+
235
+ Nix を使用して、再現可能な開発環境を構築できます。
236
+
237
+ ##### 準備
238
+
239
+ 1. [Nix をインストール](https://nixos.org/download.html)します。
240
+ 2. Flakes を有効にします(`~/.config/nix/nix.conf` に `experimental-features = nix-command flakes` を追加)。
241
+
242
+ ##### 環境の利用
243
+
244
+ - **デフォルト環境(共通ツール)に入る:**
245
+ ```bash
246
+ nix develop
247
+ ```
248
+
249
+ - **Node.js 環境に入る:**
250
+ ```bash
251
+ nix develop .#node
252
+ ```
253
+
254
+ - **Python/MkDocs 環境に入る:**
255
+ ```bash
256
+ nix develop .#python
257
+ ```
258
+
259
+ 環境から抜けるには `exit` を入力します。
260
+
261
+ ##### 依存関係の更新
262
+
263
+ ```bash
264
+ nix flake update
265
+ ```
266
+
267
+ **[⬆ back to top](#構成)**
268
+
269
+ ## 参照
@@ -1,33 +1,33 @@
1
- services:
2
- dev:
3
- build:
4
- context: .
5
- dockerfile: Dockerfile
6
- args:
7
- NODE_MAJOR: 22
8
- volumes:
9
- - .:/srv
10
- tty: true
11
- stdin_open: true
12
-
13
- mkdocs:
14
- build:
15
- context: .
16
- dockerfile: ./ops/docker/mkdoc/Dockerfile
17
- environment:
18
- PLANTUML_SERVER_URL: http://plantuml:8080/plantuml
19
- volumes:
20
- - ./docs:/docs/docs
21
- - ./README.md:/docs/README.md
22
- - ./mkdocs.yml:/docs/mkdocs.yml
23
- - ./site:/docs/site
24
- ports:
25
- - "8000:8000"
26
- command: mkdocs serve --dev-addr=0.0.0.0:8000 --livereload
27
- links:
28
- - plantuml
29
-
30
- plantuml:
31
- image: plantuml/plantuml-server:jetty
32
- environment:
33
- BASE_URL: plantuml
1
+ services:
2
+ dev:
3
+ build:
4
+ context: .
5
+ dockerfile: Dockerfile
6
+ args:
7
+ NODE_MAJOR: 22
8
+ volumes:
9
+ - .:/srv
10
+ tty: true
11
+ stdin_open: true
12
+
13
+ mkdocs:
14
+ build:
15
+ context: .
16
+ dockerfile: ./ops/docker/mkdoc/Dockerfile
17
+ environment:
18
+ PLANTUML_SERVER_URL: http://plantuml:8080/plantuml
19
+ volumes:
20
+ - ./docs:/docs/docs
21
+ - ./README.md:/docs/README.md
22
+ - ./mkdocs.yml:/docs/mkdocs.yml
23
+ - ./site:/docs/site
24
+ ports:
25
+ - "8000:8000"
26
+ command: mkdocs serve --dev-addr=0.0.0.0:8000 --livereload
27
+ links:
28
+ - plantuml
29
+
30
+ plantuml:
31
+ image: plantuml/plantuml-server:jetty
32
+ environment:
33
+ BASE_URL: plantuml
@@ -1,30 +1,30 @@
1
- /* Custom styles for diagrams */
2
-
3
- /* Mermaid diagrams */
4
- .mermaid {
5
- text-align: center;
6
- margin: 20px 0;
7
- }
8
-
9
- /* PlantUML diagrams */
10
- .plantuml {
11
- text-align: center;
12
- margin: 20px 0;
13
- }
14
-
15
- /* General diagram container */
16
- .diagram-container {
17
- background-color: #f8f8f8;
18
- border-radius: 5px;
19
- padding: 15px;
20
- margin: 20px 0;
21
- box-shadow: 0 2px 5px rgba(0,0,0,0.1);
22
- }
23
-
24
- /* Responsive diagrams */
25
- @media only screen and (max-width: 600px) {
26
- .mermaid, .plantuml {
27
- max-width: 100%;
28
- overflow-x: auto;
29
- }
1
+ /* Custom styles for diagrams */
2
+
3
+ /* Mermaid diagrams */
4
+ .mermaid {
5
+ text-align: center;
6
+ margin: 20px 0;
7
+ }
8
+
9
+ /* PlantUML diagrams */
10
+ .plantuml {
11
+ text-align: center;
12
+ margin: 20px 0;
13
+ }
14
+
15
+ /* General diagram container */
16
+ .diagram-container {
17
+ background-color: #f8f8f8;
18
+ border-radius: 5px;
19
+ padding: 15px;
20
+ margin: 20px 0;
21
+ box-shadow: 0 2px 5px rgba(0,0,0,0.1);
22
+ }
23
+
24
+ /* Responsive diagrams */
25
+ @media only screen and (max-width: 600px) {
26
+ .mermaid, .plantuml {
27
+ max-width: 100%;
28
+ overflow-x: auto;
29
+ }
30
30
  }