README

laravel 的文档阅读器，目前支持的扩展为: .md，有助于将其用作项目的 知识库 或 常见问题解答。

特性

安装
- git : git clone https://github.com/AnandPilania/laravel-docs.git
- composer : composer install anandpilania/laravel-docs
- 将 Provider 注册到 config/app.php
- AP\Docs\ServiceProvider::class
我使用了 Contract 而不是 Facade，因此 Docs 可以直接被任何 class 访问。
发布 config 和 resources
- php artisan vendor:publish
根据您的需求配置包 (app/docs.php)
- disk.root => 所有文档的根路径（默认：storage/app/docs）
http : 负责默认路由
- prefix => 路由前缀（默认：/docs）
- middleware => 默认使用 web 作为中间件组
default' : 该部分负责渲染默认的 doc
- vendor => 默认：storage/app/docs/laravel
- version => 默认：5.4
- page => 访问 //HOSTNAME/docs/laravel/5.4 时加载默认（安装）文件
- index => 默认 index 文件
- extension => 目前此包仅支持 .md，请勿更改。
security : 限制 docs 的访问
- enabled => 是否启用此功能由您决定。 true||false
- file => 根据您的意愿配置 security 文件的名称。默认 security.json 将此 security.file 添加到 vendor 目录。
扩展 :
- supported => 添加支持渲染的扩展（目前为 .md），剩余扩展将被排除
- excluded => 包含这些扩展的文件将不会显示在列表中
示例 security.json (例如：/storage/docs/app/laravel/security.json)

{ "roles": ["users"], "permissions": ["docs.show.versions"] }