slicer-ortho-docs

3D Slicer による整形外科の3D術前計画に関する、日本語の技術解説サイトのソースです。

公開先: https://yuki5696.github.io/slicer-ortho-docs/ （公開後に有効になります）

---

🔧 設定状況

項目	状態
GitHub ユーザー名	yuki5696 — 設定済み
著者名	谷　勇樹 — 設定済み
資格・専門領域・ORCID	未記入（任意）

必須の記入は完了しています。 このまま公開できます。

資格・専門領域を追加したい場合

医療関連の情報は「誰が書いたか」が検索エンジンからも読者からも重視されます。 記載すると信頼性が上がるので、余裕があれば docs/about.md の「著者」の表に行を足してください。

| | |
|---|---|
| 氏名 | 谷　勇樹 |
| 資格 | 医師／日本整形外科学会専門医 |
| 専門領域 | 外傷、脊椎、人工関節 |
| ORCID | https://orcid.org/0000-0000-0000-0000 |

⚠️ 所属施設名は書かないでください。 医療広告規制上の「特定性」を避けるためと、 異動しても内容を変えずに済むようにするためです（下の「運用上の約束」を参照）。

---

公開手順（初回のみ）

1. GitHub に public リポジトリを作る

リポジトリ名の例: slicer-ortho-docs

⚠️ public にしてください。 GitHub Pages は、無料プランでは public リポジトリからしか公開できません。 このリポジトリにはドキュメントしか入れないので、public で問題ありません。 拡張機能のコードや患者由来データは、絶対にこのリポジトリに入れないでください。

2. ファイルを push する

このフォルダで実行します。

git remote add origin https://github.com/yuki5696/slicer-ortho-docs.git
git push -u origin main

（git init と初回コミットは済んでいます）

⚠️ このフォルダはクラウド同期の対象外に置いてください。 pCloud / OneDrive / iCloud に置くと、.git フォルダが同期と衝突してリポジトリが壊れます。 複数 PC で使う場合は、各 PC で git clone してください（同期は GitHub が担います）。

3. GitHub Pages を有効にする

リポジトリの Settings → Pages → Source を 「GitHub Actions」 に設定します。

以降、main に push するたびに自動でビルド・公開されます（2〜3分）。

Actions を使わず、手軽に公開する方法

mkdocs gh-deploy

コマンド1つでビルドから公開まで行われます（gh-pages ブランチを使用）。 この場合、Settings → Pages → Source は「Deploy from a branch → gh-pages」にします。

---

2台目以降の PC で始める（自動）

新しい PC では、次の1行を PowerShell に貼り付けるだけです。

git clone https://github.com/yuki5696/slicer-ortho-docs.git; cd slicer-ortho-docs; .\setup.ps1

setup.ps1 が以下を自動で行います。

• Git / Python が入っているか確認（無ければ入手先を案内。勝手にインストールはしません）
• mkdocs-material のインストール
• ビルドが通るか確認

所要時間は約1分です。

💡 PC は何台でも使えます。 各 PC がそれぞれ独立した作業コピーを持ち、GitHub 経由でやり取りします。 同時に編集しても壊れません（競合は Git が検出して知らせます）。 このフォルダをクラウド同期フォルダに置かないでください。 Git と同期が二重になり、.git が壊れます。

---

日常の更新

方法A: GitHub の Web 画面で編集（何もインストール不要）

1. GitHub でファイルを開く
2. 鉛筆アイコン（Edit this file）をクリック
3. 編集して Commit changes
4. 2〜3分後にサイトへ反映

各ページ右上の ✏️ からも直接飛べます。外出先の PC や iPad からでも更新できます。

方法B: ローカルで確認しながら編集（スクリプト2つ）

.\serve.ps1

GitHub の最新を取り込んでから、プレビューを起動してブラウザを開きます。 ファイルを保存すると自動でリロードされます。終了は Ctrl+C。

.\publish.ps1

変更内容を表示 → ビルド確認 → 確認を取ってから GitHub へ反映します。

スクリプト	役割
setup.ps1	初回セットアップ（PC ごとに1回）
serve.ps1	書くとき。git pull + プレビュー起動
publish.ps1	公開するとき。ビルド確認 + commit + push

スクリプトの安全設計

• publish.ps1 は確認なしに push しません。変更内容を表示して y を求めます
• push 前に mkdocs build --strict を実行し、リンク切れがあれば止まります
• 医療データらしきファイル（.dcm .nii .stl .nrrd 等）が混ざっていたら中止します
• setup.ps1 は不足しているツールを勝手にインストールしません。案内するだけです

スクリプトが実行できないとき

PowerShell の実行ポリシーで止められている場合は、次のいずれかで実行できます。

powershell -ExecutionPolicy Bypass -File .\serve.ps1

または、現在のユーザーだけ許可する設定にします（1回だけ）。

Set-ExecutionPolicy -Scope CurrentUser RemoteSigned

---

ページを追加する

1. docs/ 配下に .md ファイルを作る
2. mkdocs.yml の nav: に1行足す ← 忘れるとメニューに出ません

nav:
  - チュートリアル:
      - 骨のセグメンテーション: tutorial/segmentation.md
      - 仮想整復: tutorial/reduction.md      # ← 追加

---

動画を埋め込む

docs/ の該当箇所にあるプレースホルダを、以下で置き換えます。

<div class="video-wrap">
  <iframe src="https://www.youtube-nocookie.com/embed/【動画ID】"
          allowfullscreen title="動画のタイトル"></iframe>
</div>

youtube-nocookie.com を使うと、視聴前の Cookie 設置を抑えられます。

---

公開後にやること

	内容
Google Search Console 登録	search.google.com/search-console でサイトを登録。サイトマップ（/sitemap.xml）を送信する
独自ドメイン（任意）	Settings → Pages → Custom domain。mkdocs.yml の site_url も変更する

---

運用上の約束

このサイトは医療者向けの技術教育コンテンツとして運用します。 以下を守ることで、医療広告規制の対象外という位置づけを維持します。

• ❌ 受診導線を置かない（問い合わせフォーム、予約リンク、「ご相談ください」）
• ❌ 自院の優位性を語らない（「当院では」「他施設に先駆けて」）
• ❌ 治療効果を標榜しない（「成績が向上します」）
• ❌ 患者の体験談を載せない
• ❌ 患者由来のデータ・画像を載せない
• ✅ 手法・手順の説明にとどめる
• ✅ 公開データセットを使い、CC BY のクレジットを明記する
• ✅ 研究用途である旨を明示する

---

ライセンス

• 文章・図表: CC BY 4.0
• コード断片: MIT

詳細は LICENSE を参照してください。