nano / docs
此包的最新版本(1.3.3)没有可用的许可证信息。
添加从gitlab获取工件并添加docs路由
1.3.3
2019-09-16 01:44 UTC
Requires
- curl/curl: ~1.9
- laravel/dusk: >=4.0
README
添加到您的composer.json中
"repositories": [
{
"type": "vcs",
"url": "https://git.nano.rocks/Kailum/nano-docs-package.git"
}
]
运行 composer require --dev nano/docs:dev-master
确保您的Dusk测试用例继承自NanoDocsTestCase
use Nano\Docs\NanoDocsTestCase;
abstract class DuskTestCase extends NanoDocsTestCase
{
...
}
或者包含以下代码
abstract class DuskTestCase extends BaseTestCase
{
protected function newBrowser($driver) {
return new \Nano\Docs\NanoDocsBrowser($driver);
}
...
}
发布包配置 ./artisan vendor:publish
在gitlab .env中,添加 DOCS_SCREENSHOTS=true
在服务器上,将 DOCS=true
,PROJECT_URL
,GITLAB_TOKEN
,DOCS_GITLAB_JOBS
添加到 .env 文件中
项目URL将类似于:https://git.lab.example/api/v4/projects/{project_id}
Gitlab工作项将是Gitlab运行的工作项名称(在您的gitlab-ci.yml中)
Gitlab令牌: https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html
要查看Git测试的截图,请在服务器上运行 ./artisan docs:fetch
并访问 /docs(可以通过设置服务器 .env 中的 DOCS_URL 进行更改)
要查看本地测试的截图,请运行 ./artisan docs:local
并访问 DOCS_URL/local