http://www.mchavez.com

【五分11选5app】Laravel文档工具-laravel

laravel-doc

laravel-doc 是一个用来生成文档,通过markdown来撰写文档,并提供web访问文档的项目

安装要求PHP >= 7.0.0Laravel >= 5安装
 composer require foryoufeng/laravel-doc

如果你是运行的Laravel 5.5以下的版本,需要在config/app.php的service provider中添加:

 Foryoufeng\Doc\DocServiceProvider::class

运行如下命令来发布资源文件

 php artisan doc:install

发布资源之后会多出很多文件

/public/vendor/laravel-doc  //样式文件/resources/views/docs   //界面文件/resources/mds/docs  //文档文件/resources/mds/apidocs  //api文件/app/Http/Controllers/Docs  //增加了控制器文件config/laravel_doc.php  //文档配置文件routes/web.php中增加了路由文件
访问/doc,即可看到本项目的说明文档访问/apidoc,即可看到本项目的接口说明文档如何使用普通文档的编写

resources/mds/docs中创建你的md文件,如demo.md,加入你需要的内容,
然后到app/Http/Controllers/Docs/LaravelDocController.phpindex_md中加入数据即可访问,例如:

//默认已经加入了2个例子private function index_md()    {        return  [            [                'name' => config('laravel_doc.languages.install'),                'doc_link' => 'install.md',            ],            [                'name' => config(&#,39;laravel_doc.languages.how_use'),                'doc_link&]#39; => 'how_use.md',            ],            [                'name' => 'demo',                'doc_link' => 'demo.md',            ],        ];    }

然后访问/doc,即可看到效果

控制器说明

默认文档的路径

$this->mds_path=resource_path('mds/docs/');

getMenu()里面的代码是文档显示的菜单,这个是写文档需要用到的

配置多个菜单示例
protected function getMenu()return [            [                'name'=>config('laravel_doc.languages.project_doc'),                'spread'=>true,//菜单是否展开,false不展开                'children'=>[                        'name'=>config('laravel_doc.languages.install'),                        'doc_link'=>'install.md',                     ],            ],            [                'name'=>config('laravel_doc.languages.project_doc'),                'spread'=>false,//不展开菜单                'children'=>[                        'name'=>config('laravel_doc.languages.install'),                        &#[39;doc_link'=>'install.md',                 ],            ],        ];}
                

郑重声明:本文版权归原作者所有,转载文章仅为传播更多信息之目的,如作者信息标记有误,请第一时间联系我们修改或删除,多谢。

上一篇:没有了
下一篇:没有了