Laravel 10 / 11 / 12 PHP 8.2+ Markdown viewer

Docs Viewer

A Laravel plugin that turns your `docs/` directory into a fast, organized dashboard. Originally built for the orbit-ops `/dev/docs` screen—now available via a simple `composer require`.

Packagist GitHub README

Automatic docs listing

Scans `docs/` and organizes files by category (App, Development, etc.). Quick jump to README and file view.

Safe markdown rendering
README exception path supported
Path-to-route link rewriting

Configurable for every project

Tune route prefix, middleware, layout, navigation links, and locale via `.env`. Switch language with ?lang=.

Flexible docs root path
App / Development groups via config
Default locale from env

Ready-to-use UI

Bundled Blade layout with copy buttons and collapsible code blocks. Publish views to match your app style.

Dark, focused UI
Copy & collapse in file view
Vite ready

1

Install
composer require orbit-sys-dev/laravel-dev-docs-viewer
2

Publish config/views
php artisan vendor:publish --tag=docs-viewer-config
php artisan vendor:publish --tag=docs-viewer-views
3

Set minimal env
DOCS_VIEWER_ROUTE_PREFIX=dev/docs
DOCS_VIEWER_LOCALE=ja
DOCS_VIEWER_AVAILABLE_LOCALES=ja,en
4

Verify
php artisan serve
https://localhost:8000/dev/docs?lang=en

Docs

Full setup and config examples.

Screenshots

See the top page layout.

Publish to GitHub Pages

In repo Settings → Pages, set Source to docs/. Use the repository base path (e.g. /orbit-docs-viewer/).

ja: /docs/gh-pages/
en: /docs/gh-pages/en/
Base URL: repository path