PHPackages                             orbit-sys-dev/laravel-dev-docs-viewer - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. orbit-sys-dev/laravel-dev-docs-viewer

ActiveLibrary

orbit-sys-dev/laravel-dev-docs-viewer
=====================================

Docs viewer dashboard for Laravel projects (browsing docs directory).

v0.1.0(5mo ago)01MITBladePHP ^8.2CI passing

Since Nov 20Pushed 5mo agoCompare

[ Source](https://github.com/orbit-sys-dev/orbit-docs-viewer)[ Packagist](https://packagist.org/packages/orbit-sys-dev/laravel-dev-docs-viewer)[ RSS](/packages/orbit-sys-dev-laravel-dev-docs-viewer/feed)WikiDiscussions develop Synced 1mo ago

READMEChangelogDependencies (5)Versions (3)Used By (0)

orbit-docs-viewer (orbit-sys-dev/laravel-dev-docs-viewer)
=========================================================

[](#orbit-docs-viewer-orbit-sys-devlaravel-dev-docs-viewer)

Live site (GitHub Pages): [EN](https://orbit-sys-dev.github.io/orbit-docs-viewer/gh-pages/en/) / [JA](https://orbit-sys-dev.github.io/orbit-docs-viewer/gh-pages/)

Read in Japanese: [README.ja.md](README.ja.md)
Development docs usage (JA): [docs/guide/development\_usage.md](docs/guide/development_usage.md)App docs usage (JA): [docs/guide/app\_docs\_usage.md](docs/guide/app_docs_usage.md)

License: [MIT](LICENSE) / [MIT (JA)](LICENSE.ja.md)

Contributing: [CONTRIBUTING.md](CONTRIBUTING.md) / [CONTRIBUTING.ja.md](CONTRIBUTING.ja.md)

Laravel plugin for browsing documents under `docs/`. It packages the orbit-ops `/dev/docs` screen so you can drop it into any project with a simple `composer require`.

UI preview
----------

[](#ui-preview)

[![Docs viewer sample](docs/images/top.en.png)](docs/images/top.en.png)

Installation
------------

[](#installation)

1. Install

```
composer require orbit-sys-dev/laravel-dev-docs-viewer
```

2. Publish config (and views if you want to customize layout/translations)

```
php artisan vendor:publish --tag=docs-viewer-config
php artisan vendor:publish --tag=docs-viewer-views   # when you want to tweak layout or translations
```

3. `.env` example

```
DOCS_VIEWER_ROOT_DIR=docs
DOCS_VIEWER_APP_PATH=docs/app
DOCS_VIEWER_ROUTE_PREFIX=dev/docs
DOCS_VIEWER_ROUTE_NAME_PREFIX=dev.docs.
DOCS_VIEWER_MIDDLEWARE=web,auth
DOCS_VIEWER_LOCALE=ja
DOCS_VIEWER_AVAILABLE_LOCALES=ja,en
DOCS_VIEWER_LOCALE_QUERY=lang
DOCS_VIEWER_LAYOUT=docs-viewer::layouts.docs
DOCS_VIEWER_DASHBOARD_URL=/ops
DOCS_VIEWER_DASHBOARD_LABEL="Back to Dev Dashboard"
DOCS_VIEWER_HOME_URL=/
DOCS_VIEWER_HOME_LABEL="Back to Home"
```

4. Place your `docs/` directory

Drop in a structure such as `docs/app` and `docs/development/{memo,operation,task}` and you can use it immediately. Open `/dev/docs` in your browser to verify.

Routing
-------

[](#routing)

Default routes (prefix and middleware are configurable):

- `GET /dev/docs` → Top (`dev.docs.viewer`)
- `GET /dev/docs/app` → App docs list (`dev.docs.app`)
- `GET /dev/docs/development` → Development cards (`dev.docs.development`)
- `GET /dev/docs/development/{group}` → Development group list (`dev.docs.development.group`)
- `GET /dev/docs/file` → Single file view (`dev.docs.viewer.file`, `?path=...`)

Configuration notes
-------------------

[](#configuration-notes)

- `root_dir`: Relative path to the docs root (default `docs`)
- `app_docs_path`: Path for the App docs category (appended to the root)
- `development_groups`: Array of labels/paths for Development groups
- `route.prefix` / `route.name_prefix` / `route.middleware`: Switch routing and middleware
- `layout`: Layout Blade. Defaults to the bundled simple layout; override to use your app layout.
- `dashboard_url`: Target for “Back to Dev Dashboard”. Set null to hide.
- `timezone`: Timezone used for date display. Falls back to `config('app.timezone')` when unset.
- `locale` / `locales` / `locale_query_key`: Set default locale and the URL query key (default `lang`). Switch languages with `?lang=en`, etc.

License
-------

[](#license)

MIT

###  Health Score

30

—

LowBetter than 64% of packages

Maintenance70

Regular maintenance activity

Popularity1

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity38

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

177d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/2c4b2352ccce2be3b3e098520be56e5491775a5e68c4acae1bdf6003402d2d43?d=identicon)[o-kazuhide-takahashi](/maintainers/o-kazuhide-takahashi)

---

Top Contributors

[![o-kazuhide-takahashi](https://avatars.githubusercontent.com/u/18205696?v=4)](https://github.com/o-kazuhide-takahashi "o-kazuhide-takahashi (11 commits)")

### Embed Badge

![Health badge](/badges/orbit-sys-dev-laravel-dev-docs-viewer/health.svg)

```
[![Health](https://phpackages.com/badges/orbit-sys-dev-laravel-dev-docs-viewer/health.svg)](https://phpackages.com/packages/orbit-sys-dev-laravel-dev-docs-viewer)
```

###  Alternatives

[roots/acorn

Framework for Roots WordPress projects built with Laravel components.

9682.1M97](/packages/roots-acorn)[pressbooks/pressbooks

Pressbooks is an open source book publishing tool built on a WordPress multisite platform. Pressbooks outputs books in multiple formats, including PDF, EPUB, web, and a variety of XML flavours, using a theming/templating system, driven by CSS.

44643.1k1](/packages/pressbooks-pressbooks)[dragon-code/pretty-routes

Pretty Routes for Laravel

10058.7k4](/packages/dragon-code-pretty-routes)[laravellux/html

HTML and Form Builders for the Laravel Framework

35239.2k3](/packages/laravellux-html)[konekt/html

HTML and Form Builders for the Laravel Framework

24403.2k5](/packages/konekt-html)[aedart/athenaeum

Athenaeum is a mono repository; a collection of various PHP packages

245.2k](/packages/aedart-athenaeum)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)