diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 469fa35..9724486 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -66,10 +66,48 @@ 詳細は [`CLAUDE.md`](./CLAUDE.md) > プロンプトインジェクション対策。 +## 新しい教材を投稿するには + +### 1. フォルダ構造を確認する + +``` +content/ +├── claude-code/ Claude Code の機能・使い方 +├── claude-api/ Claude API の活用 +├── ai-workflows/ ツール横断・実務への応用 +└── other-tools/ Cursor, Copilot など +``` + +### 2. テンプレートをコピーする + +```bash +# スライド教材の場合 +cp -r _templates/slides content/<カテゴリ>/<フォルダ名> + +# 記事の場合 +cp -r _templates/article content/<カテゴリ>/<フォルダ名> +``` + +フォルダ名は `kebab-case`（例：`hooks-basics`、`mcp-setup`）。 + +### 3. README.md のメタデータを埋める + +```yaml +--- +title: 教材タイトル +author: "@your-github-handle" +tags: [claude-code, hooks] +level: beginner # beginner / intermediate / advanced +type: slides # slides / article +--- +``` + +### 4. PR を出す + ## PR ワークフロー 1. このリポジトリを fork -2. ブランチを作成（`fix/typo-slide-05` のように内容がわかる名前） +2. ブランチを作成（`feat/claude-code-hooks-basics` のように内容がわかる名前） 3. 変更を commit 4. PR を作成、本文に変更の概要と理由を書く 5. CI が green になることを確認 diff --git a/_templates/article/README.md b/_templates/article/README.md new file mode 100644 index 0000000..839c25a --- /dev/null +++ b/_templates/article/README.md @@ -0,0 +1,17 @@ +--- +title: 記事タイトル +author: "@your-github-handle" +tags: [claude-code, タグ2] +level: beginner +type: article +--- + +# 記事タイトル + +1〜2 文で概要を書く。 + +## Authors + +| 役割 | 名前 | 貢献 | +|------|------|------| +| Initial author | [@your-github-handle](https://github.com/your-github-handle) | 初版作成 | diff --git a/_templates/article/index.html b/_templates/article/index.html new file mode 100644 index 0000000..ccc4fbb --- /dev/null +++ b/_templates/article/index.html @@ -0,0 +1,29 @@ + + + + +タイトル + + + + + + + + + + +
+

タイトル

+

by @your-github-handle · 2026

+ +

はじめに

+

内容を書く。

+ +

Credits

+ +
+ + diff --git a/_templates/slides/README.md b/_templates/slides/README.md new file mode 100644 index 0000000..23fbc98 --- /dev/null +++ b/_templates/slides/README.md @@ -0,0 +1,42 @@ +--- +title: 教材タイトル +author: "@your-github-handle" +tags: [claude-code, タグ2, タグ3] +level: beginner +type: slides +--- + +# 教材タイトル + +1〜2 文で概要を書く。何を学べるか・誰向けか。 + +## このディレクトリの中身 + +``` +フォルダ名/ +├── index.html ← 本体（ブラウザで開く / AI に読ませる） +├── README.md ← このファイル +└── _assets/ ← 画像・図（必要な場合のみ） +``` + +`index.html` は `shared/` の以下に依存（パスは `../../../shared/`）： +- `deck-stage.js` — スライドナビゲーションエンジン +- `theme.css` — デザインシステム +- `progress-strip.js` — 下部プログレスバー + +## 想定読者 + +この教材が役に立つ人・前提知識を書く。 + +## 内容 + +| # | スライドタイトル | 内容 | +|---|----------------|------| +| 01 | Cover | — | +| 02 | 読み方 | — | + +## Authors + +| 役割 | 名前 | 貢献 | +|------|------|------| +| Initial author | [@your-github-handle](https://github.com/your-github-handle) | 初版作成 | diff --git a/_templates/slides/index.html b/_templates/slides/index.html new file mode 100644 index 0000000..f0cd70b --- /dev/null +++ b/_templates/slides/index.html @@ -0,0 +1,105 @@ + + + + +タイトル — サブタイトル + + + + + + + + + + + + + + + + +
+
+
カテゴリ名 · トピック
+

+ タイトル +

+

+ サブタイトル・キャッチコピー +

+
+
+ @your-github-handle + 2026 +
+
+ + +
+
+ トピック名 · How to read + 02 / XX +
+
+
Foreword
+

詰まったら、AI に聞きながら進めてください

+

+ スライドは概要のみ。詳細は隣の AI に聞く前提で作っています +

+
+
+ @your-github-handle + 02 / XX +
+
+ + +
+
+ Chapter 1 · 章のテーマ + 03 / XX +
+
+
ラベル
+

スライドの主張を 1 文で

+

補足説明

+
+ +
+
+ @your-github-handle + 03 / XX +
+
+ + +
+
+ Credits + XX / XX +
+
+

この教材に関わった人

+ +
+
+ @your-github-handle + XX / XX +
+
+ + + + diff --git a/content/ai-workflows/README.md b/content/ai-workflows/README.md new file mode 100644 index 0000000..5210090 --- /dev/null +++ b/content/ai-workflows/README.md @@ -0,0 +1,6 @@ +# ai-workflows + +ツールを横断した実務・業務への応用事例カテゴリ。 + +特定ツールの機能解説ではなく「実際にこう使う」という文脈のコンテンツを集める。 +例：コードレビューフロー、ドキュメント自動生成、業務自動化の事例など。 diff --git a/content/claude-api/README.md b/content/claude-api/README.md new file mode 100644 index 0000000..2667dce --- /dev/null +++ b/content/claude-api/README.md @@ -0,0 +1,5 @@ +# claude-api + +Claude API の活用方法を解説する教材カテゴリ。 + +SDK の使い方・Tool Use・Prompt Caching など、API レベルでの実装例を扱う。 diff --git a/content/claude-code/README.md b/content/claude-code/README.md new file mode 100644 index 0000000..5207001 --- /dev/null +++ b/content/claude-code/README.md @@ -0,0 +1,21 @@ +# claude-code + +Claude Code の機能・使い方を解説する教材カテゴリ。 + +各フォルダが 1 投稿（HTML スライドまたは記事）に対応する。 + +## 投稿例 + +| フォルダ名 | 内容 | +|-----------|------| +| `intro/` | Claude Code とは何か（入門） | +| `setup/` | 環境構築・インストール手順 | +| `claude-md/` | CLAUDE.md の書き方と効果 | +| `hooks/` | Hooks の仕組みと実用例 | +| `mcp/` | MCP サーバーの導入・活用 | +| `memory/` | メモリ・コンテキスト管理 | +| `slash-commands/` | カスタムスラッシュコマンドの作り方 | + +## 新しい投稿を追加するには + +`_templates/slides/` または `_templates/article/` をコピーして、このフォルダ直下に配置してください。 diff --git a/03-claude-md/index.html b/content/claude-code/claude-md/index.html similarity index 99% rename from 03-claude-md/index.html rename to content/claude-code/claude-md/index.html index 8ac49ab..bcdfd21 100644 --- a/03-claude-md/index.html +++ b/content/claude-code/claude-md/index.html @@ -10,9 +10,9 @@ - - - + + + diff --git a/01-claude-code-intro/README.md b/content/claude-code/intro/README.md similarity index 100% rename from 01-claude-code-intro/README.md rename to content/claude-code/intro/README.md diff --git a/01-claude-code-intro/_assets/_split-icons.py b/content/claude-code/intro/_assets/_split-icons.py similarity index 100% rename from 01-claude-code-intro/_assets/_split-icons.py rename to content/claude-code/intro/_assets/_split-icons.py diff --git a/01-claude-code-intro/_assets/use-automation.png b/content/claude-code/intro/_assets/use-automation.png similarity index 100% rename from 01-claude-code-intro/_assets/use-automation.png rename to content/claude-code/intro/_assets/use-automation.png diff --git a/01-claude-code-intro/_assets/use-code.png b/content/claude-code/intro/_assets/use-code.png similarity index 100% rename from 01-claude-code-intro/_assets/use-code.png rename to content/claude-code/intro/_assets/use-code.png diff --git a/01-claude-code-intro/_assets/use-comm.png b/content/claude-code/intro/_assets/use-comm.png similarity index 100% rename from 01-claude-code-intro/_assets/use-comm.png rename to content/claude-code/intro/_assets/use-comm.png diff --git a/01-claude-code-intro/_assets/use-creative.png b/content/claude-code/intro/_assets/use-creative.png similarity index 100% rename from 01-claude-code-intro/_assets/use-creative.png rename to content/claude-code/intro/_assets/use-creative.png diff --git a/01-claude-code-intro/_assets/use-doc.png b/content/claude-code/intro/_assets/use-doc.png similarity index 100% rename from 01-claude-code-intro/_assets/use-doc.png rename to content/claude-code/intro/_assets/use-doc.png diff --git a/01-claude-code-intro/_assets/use-learn.png b/content/claude-code/intro/_assets/use-learn.png similarity index 100% rename from 01-claude-code-intro/_assets/use-learn.png rename to content/claude-code/intro/_assets/use-learn.png diff --git a/01-claude-code-intro/_assets/use-research.png b/content/claude-code/intro/_assets/use-research.png similarity index 100% rename from 01-claude-code-intro/_assets/use-research.png rename to content/claude-code/intro/_assets/use-research.png diff --git a/01-claude-code-intro/_assets/use-slide.png b/content/claude-code/intro/_assets/use-slide.png similarity index 100% rename from 01-claude-code-intro/_assets/use-slide.png rename to content/claude-code/intro/_assets/use-slide.png diff --git a/01-claude-code-intro/index.html b/content/claude-code/intro/index.html similarity index 99% rename from 01-claude-code-intro/index.html rename to content/claude-code/intro/index.html index 87db607..bb60c75 100644 --- a/01-claude-code-intro/index.html +++ b/content/claude-code/intro/index.html @@ -25,9 +25,9 @@ ============================================================ --> - - - + + + @@ -51,7 +51,7 @@

- 教材サイトの QR コード + 教材サイトの QR コード スマホで開く diff --git a/02-setup/index.html b/content/claude-code/setup/index.html similarity index 99% rename from 02-setup/index.html rename to content/claude-code/setup/index.html index 59482c5..e9927c4 100644 --- a/02-setup/index.html +++ b/content/claude-code/setup/index.html @@ -10,9 +10,9 @@ - - - + + + diff --git a/content/other-tools/README.md b/content/other-tools/README.md new file mode 100644 index 0000000..93cb14a --- /dev/null +++ b/content/other-tools/README.md @@ -0,0 +1,3 @@ +# other-tools + +Cursor・GitHub Copilot など、Claude Code 以外の AI ツールを扱う教材カテゴリ。