Skip to content

docs サイトを Docusaurus へ移行(既存ページは文面・URL とも据え置き) - #28

Merged
hal-shu-sato merged 5 commits into
masterfrom
docs/migrate-to-docusaurus
Jul 27, 2026
Merged

docs サイトを Docusaurus へ移行(既存ページは文面・URL とも据え置き)#28
hal-shu-sato merged 5 commits into
masterfrom
docs/migrate-to-docusaurus

Conversation

@kazeruch

Copy link
Copy Markdown
Contributor

docs サイトの生成を Jekyll から Docusaurus に切り替えます。既存ドキュメントの文面と URL は変更していません。

#25 から「Docusaurus の導入」部分だけを切り出したものです。チュートリアルと GPU 使い方ガイドの追加は #27 に分けてあります。

(ブランチ名変更に伴い #26 が閉じられたため、同一内容で立て直したものです)

変更点

  • 既存 5 ページと index.mddocs/ 配下へ移動(本文はバイト単位で変更なし
  • Jekyll の _config.yml を削除し、GitHub Actions(.github/workflows/deploy.yml)でのビルド・デプロイへ
  • Docusaurus 一式を追加(docusaurus.config.js / sidebars.js / package.json / src/css/custom.css / static/
  • 日本語の全文検索を有効化(@easyops-cn/docusaurus-search-local
  • README.md を追加

差分は package-lock.json を除くと 24 ファイル / +256・-1 です。

URL

生成されるページのパスは現行と同一です。

  • / /user_manual /jupyterhub_user_manual /community_rules /slurm_user_manual /llmgateway_user_manual

サイドバーとページタイトルは各ファイルの # 見出しをそのまま使います。並び順も現行 index.md のリンク順のままです。

マージ時にお願いしたい設定変更

Settings → Pages → Build and deployment → Source を「GitHub Actions」に切り替える必要があります。 現在は master ブランチからの Jekyll ビルドになっているため、切り替えないとデプロイジョブが失敗します。workflow_dispatch を入れてあるので、切り替え後に手動で流し直せます。

動作確認

ローカルで npm ci && npm run build が警告なしで成功すること、上記 6 パスと画像が生成されることを確認済みです。

🤖 Generated with Claude Code

- 既存5ページと index.md を docs/ へ移設。本文は変更なし、生成される
  URL も /user_manual, /slurm_user_manual 等でこれまでと同一
- Jekyll の _config.yml を削除し、GitHub Actions でのビルド・デプロイに変更
- サイドバー・ページタイトルは各ファイルの見出しから自動生成

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@hal-shu-sato
hal-shu-sato requested a review from a team July 26, 2026 16:10
@kazeruch

Copy link
Copy Markdown
Contributor Author

lgtm

@hal-shu-sato hal-shu-sato self-assigned this Jul 27, 2026
@hal-shu-sato
hal-shu-sato merged commit 2079bb0 into master Jul 27, 2026
@hal-shu-sato
hal-shu-sato deleted the docs/migrate-to-docusaurus branch July 27, 2026 02:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants