README

[][活跃]

在 Laravel 上实现动态文档从未如此简单。

安装

1) 下载

将仓库克隆到 ./packages/victoranw。克隆后完整路径为：./packages/victoranw/laradoc

2) Composer

在 composer.json 中添加

"repositories": {
	"victoranw/laradoc": {
		"type": "path",
		"url": "./packages/victoranw/laradoc"
	}
}

在终端中

$ composer require victoranw/laradoc

3) 提供者

在文件 config/app.php 中添加

'providers'  => [
	\Victoranw\Laradoc\LaradocServiceProvider::class
]

4) 安装文件

安装配置和迁移文件

$ php artisan vendor:publish --provider="Victoranw\Laradoc\LaradocServiceProvider"

5) 迁移

运行迁移

$ php artisan migrate

6) 缓存

清理缓存

$ php artisan config:clear
$ php artisan route:clear

配置

路径：./config/laradoc.php

使用

访问 https://:8000/doc 以访问连接。*** 注意：请确保您要连接的用户有访问文档的权限 ***

登录后，您可以查看文档或进入管理员空间

管理员空间

管理员空间分为两部分，一部分用于管理文档内容，另一部分用于管理用户访问权限。

文档内容管理

树形结构的前几层是主要分类。然后，在这些分类中，您可以添加任意数量的子分类。在每个分类中，您可以添加一个或多个页面，这将在阅读文档时创建子菜单。在编写页面时，所有内容都会自动记录（页面标题和内容）。

用户管理

用户管理很简单，总结为两个动作

添加/删除用户对文档阅读的访问权限
添加/删除用户对管理员的访问权限

测试

$ ./vendor/bin/phpunit

安全

如果遇到问题，请通过 victor.anweiler@epitech.eu 联系我们

鸣谢

Victor Anweiler

victoranw / laradoc

维护者

详细信息