README

此包生成一个HTML页面，您可以在其中查看所有包的readme文件，因此您无需再访问每个包的主页来查找文档。

预览

安装

使用以下命令通过composer安装此包

composer require seekerliu/laravel-readme-viewer

更新composer后，将服务提供者添加到config/app.php文件中的providers数组中

Seekerliu\Readme\Providers\ReadmeServiceProvider::class,

如果只想在开发系统中安装此包，请在composer命令中添加--dev标志

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

在Laravel中，您可以在app/Providers/AppServiceProvider.php文件中添加以下代码，在register()方法内，而不是在config/app.php文件中添加服务提供者

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

这将允许您的应用程序在非生产环境中加载Laravel 5 Packages的Readme文件（文档）查看器。

用法

现在，您可以通过以下链接在浏览器中查看所有包的文档。

http://yoursite.app/readme

自定义路由

如果您需要自定义路由，首先需要发布配置文件

php artisan vendor:publish --tag=readme

然后您可以在'/config/readme.php'中更改路由

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

许可证

Laravel 5 Packages的Readme文件（文档）查看器是开源软件，许可协议为MIT许可证

seekerliu / laravel-readme-viewer

维护者

详细信息

README

预览

安装

用法

自定义路由

许可证