MkDocs サイト運用・活用ガイド¶

# docsディレクトリに新しいファイルを作成
touch docs/getting-started.md
touch docs/tutorial.md
touch docs/reference.md

site_name: My Documentation

theme:
  name: material
  language: ja

nav:
  - ホーム: index.md
  - はじめに: getting-started.md
  - チュートリアル: tutorial.md
  - リファレンス: reference.md
  - About: about.md

docs/
├── index.md
├── getting-started/
│   ├── index.md
│   ├── installation.md
│   └── quickstart.md
├── tutorial/
│   ├── index.md
│   ├── basic.md
│   └── advanced.md
└── reference/
    ├── index.md
    ├── api.md
    └── config.md

nav:
  - ホーム: index.md
  - はじめに:
    - getting-started/index.md
    - インストール: getting-started/installation.md
    - クイックスタート: getting-started/quickstart.md
  - チュートリアル:
    - tutorial/index.md
    - 基礎編: tutorial/basic.md
    - 応用編: tutorial/advanced.md
  - リファレンス:
    - reference/index.md
    - API: reference/api.md
    - 設定: reference/config.md

# 記事タイトル

記事の概要を1-2行で説明

## 前提条件

- 必要な知識や準備
- 参照すべき前の記事

## 実現できること

この記事で何が学べるかを明確に

## 手順

### 1. 最初のステップ

具体的な手順を分かりやすく

### 2. 次のステップ

コードブロックや図解を活用

## まとめ

- 実現したこと
- 次のステップへの誘導

## 関連記事

- [関連記事1](./link1.md)
- [関連記事2](./link2.md)

# h1 - ページタイトル（1つのみ）
## h2 - 大項目
### h3 - 中項目  
#### h4 - 小項目

# Bashコマンド例
mkdocs serve

# YAML設定例
site_name: My Site
theme:
  name: material

# Pythonコード例
def hello():
    print("Hello, World!")

!!! note "メモ"
    補足情報や注意点

!!! tip "ヒント"
    便利な使い方

!!! warning "注意"
    重要な警告

!!! success "成功"
    成果や達成事項

# 1. 新しい記事の作成
touch docs/new-article.md

# 2. ローカルで執筆・確認
mkdocs serve

# 3. 変更をコミット
git add .
git commit -m "Add new article about XXX"

# 4. GitHub Pagesに反映
mkdocs gh-deploy

# 既存記事を編集後
git add docs/existing-article.md
git commit -m "Update article: add troubleshooting section"
mkdocs gh-deploy

## 2024年3月計画

### Week 1
- [ ] チュートリアル記事の改訂
- [ ] 新機能解説記事の執筆

### Week 2  
- [ ] FAQ集の充実
- [ ] 既存記事のリンク整理

### Week 3
- [ ] ユースケース記事の追加
- [ ] 画像・図表の追加

### Week 4
- [ ] 月次レビューと来月計画

# 1. 新しい記事用ブランチ作成
git checkout -b feature/new-tutorial

# 2. 記事作成・編集
# docs/tutorial/new-feature.md を作成

# 3. ローカル確認
mkdocs serve

# 4. プルリクエスト作成
git add .
git commit -m "Add tutorial for new feature"
git push origin feature/new-tutorial

## 変更内容

- [ ] 新記事の追加
- [ ] 既存記事の更新
- [ ] 設定ファイルの変更

## チェックリスト

- [ ] ローカルでビルド確認済み
- [ ] リンクが正常に動作する
- [ ] 誤字脱字をチェック済み
- [ ] 画像が適切に表示される

## 関連Issue

Closes #123

# スタイルガイド

## 基本方針
- です・ます調で統一
- 専門用語は初出時に説明
- コマンドは`バッククォート`で囲む

## 表記ルール
- GitHub (× Github)
- JavaScript (× Javascript)  
- Markdown (× markdown)

ホーム
├── はじめに（新規ユーザー向け）
│   ├── 概要・特徴
│   ├── インストール
│   └── クイックスタート
├── チュートリアル（段階的学習）
│   ├── 基礎編
│   ├── 実践編
│   └── 応用編
├── ガイド（目的別解説）
│   ├── デプロイメント
│   ├── カスタマイズ
│   └── トラブルシューティング
└── リファレンス（辞書的情報）
    ├── API仕様
    ├── 設定項目
    └── FAQ

# mkdocs.yml
plugins:
  - meta

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/username

---
title: 具体的で検索されやすいタイトル
description: 記事の要約（150文字以内）
keywords: mkdocs, github pages, documentation
---

# 記事本文

関連記事への適切なリンク：
- [前の手順](./previous-step.md)
- [基本設定](../basics/configuration.md)
- [トラブルシューティング](../../troubleshooting.md)