PHPackages                             seekerliu/laravel-readme-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. [Utility & Helpers](/categories/utility)
4. /
5. seekerliu/laravel-readme-viewer

ActiveLibrary[Utility & Helpers](/categories/utility)

seekerliu/laravel-readme-viewer
===============================

A tool to view all the package's readme files.

0.5(9y ago)6953MITHTMLPHP >=5.6.4

Since Dec 30Pushed 6y ago2 watchersCompare

[ Source](https://github.com/seekerliu/laravel-readme-viewer)[ Packagist](https://packagist.org/packages/seekerliu/laravel-readme-viewer)[ RSS](/packages/seekerliu-laravel-readme-viewer/feed)WikiDiscussions master Synced 5d ago

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

Laravel 5 Packages's Readme File(Docs) Viewer
---------------------------------------------

[](#laravel-5-packagess-readme-filedocs-viewer)

This package generates a html page that you can see all of your packages's readme file, So you no longer need to go to each package's homepage to find documents。

### Preview

[](#preview)

[![Packages Readmes Viewer](https://camo.githubusercontent.com/6c5e1239f6a0aef4eb14feb13be722209bac96e07da8458bd3876f69da226840/687474703a2f2f7365656b65726c69752e636f6d2f73746f726167652f46413143464146352d364635382d344433422d424235372d3131353936304644433345362e6a7067)](https://camo.githubusercontent.com/6c5e1239f6a0aef4eb14feb13be722209bac96e07da8458bd3876f69da226840/687474703a2f2f7365656b65726c69752e636f6d2f73746f726167652f46413143464146352d364635382d344433422d424235372d3131353936304644433345362e6a7067)

### Install

[](#install)

Require this package with composer using the following command:

```
composer require seekerliu/laravel-readme-viewer
```

After updating composer, add the service provider to the `providers` array in `config/app.php`

```
Seekerliu\Readme\Providers\ReadmeServiceProvider::class,
```

To install this package on only development systems, add the `--dev` flag to your composer command:

```
composer require --dev seekerliu/laravel-readme-viewer
```

In Laravel, instead of adding the service provider in the `config/app.php` file, you can add the following code to your `app/Providers/AppServiceProvider.php` file, within the `register()` method:

```
public function register()
{
    if ($this->app->environment() == 'local') {
        $this->app->register('Seekerliu\Readme\Providers\ReadmeServiceProvider');
    }
    // ...
}
```

This will allow your application to load the Laravel 5 Packages's Readme File(Docs) Viewer on non-production enviroments.

### Usage

[](#usage)

You can now view all the docs of your packages in your browser by follow url.

```
http://yoursite.app/readme
```

### Custom Route

[](#custom-route)

If you need to custom route, you need to publish config file first

```
php artisan vendor:publish --tag=readme
```

Then you can change route in '/config/readme.php'

```
'route' => [
        'prefix' => '/readme/{packageName?}',
        'action' => 'Seekerliu\Readme\Controllers\ReadmeController@index',
        'name' => 'readme.index',
],
```

### License

[](#license)

The Laravel 5 Packages's Readme File(Docs) Viewer is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)

###  Health Score

27

—

LowBetter than 49% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity16

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity51

Maturing project, gaining track record

 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

Every ~0 days

Total

4

Last Release

3425d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/8a75a733b92b7487ba3cb6e4d629a9df143f2865afd262e00f017de8d006621e?d=identicon)[seekerliu](/maintainers/seekerliu)

---

Top Contributors

[![seekerliu](https://avatars.githubusercontent.com/u/8923281?v=4)](https://github.com/seekerliu "seekerliu (10 commits)")

### Embed Badge

![Health badge](/badges/seekerliu-laravel-readme-viewer/health.svg)

```
[![Health](https://phpackages.com/badges/seekerliu-laravel-readme-viewer/health.svg)](https://phpackages.com/packages/seekerliu-laravel-readme-viewer)
```

###  Alternatives

[barryvdh/laravel-ide-helper

Laravel IDE Helper, generates correct PHPDocs for all Facade classes, to improve auto-completion.

14.9k123.0M687](/packages/barryvdh-laravel-ide-helper)[yajra/laravel-datatables-oracle

jQuery DataTables API for Laravel

4.9k33.8M339](/packages/yajra-laravel-datatables-oracle)[orchestra/canvas

Code Generators for Laravel Applications and Packages

21017.2M158](/packages/orchestra-canvas)[illuminate/session

The Illuminate Session package.

9937.4M753](/packages/illuminate-session)[ashallendesign/favicon-fetcher

A Laravel package for fetching website's favicons.

190272.4k3](/packages/ashallendesign-favicon-fetcher)[recca0120/laravel-erd

Laravel ERD automatically generates Entity-Relationship Diagrams from your Laravel models and displays them using Vuerd.

36072.0k](/packages/recca0120-laravel-erd)

PHPackages © 2026

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