快速查看 Laravel 已安装 Packages 的 Readme 文档小工具

Coding的时候，经常需要查阅各个Package的文档。在以前，去每个Package的官网查找各自的文档，比较麻烦。所以我做了一个小工具，可以把所有Packages的文档放在一个页面里面查阅，欢迎各位品尝。

预览

原理

• 每个Package在其安装目录下都会有一个README.MD文件;
• 首先读取composer.json，获取require和require-dev的Package列表;
• 读取README.MD文件，并由Markdown转化为Html;
• 使用了GithubMarkdown以及GithubMarkdownCSS。

安装方法

使用composer安装至dev环境：

composer require --dev seekerliu/packagesreadmes

注册ServiceProvider至本地环境：

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

使用方法

现在你就可以通过下面的Url来查看所有Packages的Readme文档了：

http://yoursite.app/readme

自定义路由

如果你需要自定义路由，需要先publish配置文件：

php artisan vendor:publish --tag=readme

然后编辑 '/config/readme.php'中的route部分：

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

即可修改路由。

项目源码

https://github.com/seekerliu/packagesreadm...