ドキュメント自動一覧
`docs/` 配下をカテゴリごとに自動スキャンし、設計書・Development などをカード表示。README へのクイックリンクも付属。
- Markdown を安全に HTML 化
- README 例外パスも指定可能
- パスからルートへ自動リンク
orbit docs viewer
Laravel 10 / 11 / 12
PHP 8.2+
Markdown viewer
Docs ビューアー
`docs/` 配下の資料をブラウザで素早く整理・閲覧できる Laravel プラグインです。orbit-ops の `/dev/docs` 画面をパッケージ化し、`composer require` だけで導入できます。
特徴
環境に合わせて柔軟
.env でルート prefix、middleware、レイアウト、ダッシュボードへの戻り先などを切替。ロケールも `?lang=` で即変更。
- 可変 root ディレクトリ
- App/Development グループを設定
- ロケール既定値を `.env` で
プロダクトに寄り添う UI
デフォルトの Blade レイアウトを同梱しつつ、`vendor:publish` でビューを配布可能。アプリ共通レイアウトへの置換も容易。
- ダーク基調のシンプル UI
- コピー/折りたたみなど実用機能
- Vite バンドル対応
セットアップ
-
1インストールcomposer require orbit-sys-dev/laravel-dev-docs-viewer
-
2publishphp artisan vendor:publish --tag=docs-viewer-config
php artisan vendor:publish --tag=docs-viewer-views -
3.env に最低限の設定DOCS_VIEWER_ROUTE_PREFIX=dev/docs
DOCS_VIEWER_LOCALE=ja
DOCS_VIEWER_AVAILABLE_LOCALES=ja,en -
4動作確認php artisan serve
https://localhost:8000/dev/docs?lang=ja
リソース
ドキュメント
導入手順と設定例を README で確認できます。
スクリーンショット
トップページの UI の参考に利用してください。
GitHub Pages 公開メモ
リポジトリの Settings → Pages で Source を docs/ に設定すると、このページを公開できます。
- Base URL:
/リポジトリ名/ - ja:
/docs/gh-pages/ - en:
/docs/gh-pages/en/