国产开源文档办理体系——Wizard
先容
Wizard是一款开源文档办理体系,支持三种格式典范的文档办理,分散是Markdown、Swagger和Table,以便于满意不同场景和不同需求下的文档办理,Markdown典范是当下比力常用的文档典范,固然以前满意大大多需求,但是当需求变得繁复,那么使用起来就相对不太够了!
开源地点
码云:
https://gitee.com/orionis/wizardGithub:https://github.com/mylxsw/wizard
功效清单
现在Wizard以前包含了以下功效,干系于很多单调的文档办理体系,Wizard显得就要丰厚的多了
- Swagger,Markdown,Table 典范的文档办理
- 文档修正汗青办理
- 文档修正差别比力
- 用户权限办理
- 项目分组办理
- LDAP 一致身份认证
- 文档搜刮,标签搜刮
- 阅读形式
- 文档批评
- 消息关照
- 文档分享
- 统计功效
- 流程图,序列图,饼图,Tex LaTex 封建公式支持
- 多主题切换
页面截图
摆设办法
现在支持两种办法摆设,分散是Docker摆设和平凡手动摆设,假如了解一点Docker发起使用Docker摆设,相对手动摆设要简便不少,一下就是Docker摆设办法,手动摆设可以参考码云大概Github上具体的先容
- 办法一
起首关于新安装用户,必要实行数据库的初始化
docker run -it --rm --name wizard \
-e DB_HOST=host.docker.internal \
-e DB_PORT=3306 \
-e DB_DATABASE=wizard \
-e DB_USERNAME=wizard \
-e DB_PASSWORD=wizard \
mylxsw/wizard 初始化下令
这里的 初始化下令 包含两个,依次实行即可
- php artisan migrate:install
- php artisan migrate
最初,直接运转底下的 Docker 下令即可
docker run -d --name wizard \
-e DB_HOST=host.docker.internal \
-e DB_PORT=3306 \
-e DB_DATABASE=wizard \
-e DB_USERNAME=wizard \
-e DB_PASSWORD=wizard \
-p 8080:80 \
-v /Users/mylxsw/Downloads:/webroot/storage/app/public \
mylxsw/wizard
- 办法二
我们必要创建一个Dockerfile,在Dockerfile中添加情况设置,好比我接纳了宿主机上安装的MySQL办事器,就有了底下的这段Dockerfile设置
FROM mylxsw/wizard:latest
# 数据库毗连设置
# 这里可以依据必要添加别的的Env设置,可用选项参考项目标.env.example文件
ENV DB_CONNECTION=mysql
ENV DB_HOST=host.docker.internal
ENV DB_PORT=3306
ENV DB_DATABASE=wizard_2
ENV DB_USERNAME=wizard
ENV DB_PASSWORD=wizard
ENV WIZARD_NEED_ACTIVATE=false
# 拜候地点,仅有准确设置后,导出的 markdown 文档图片才干正常展现
ENV APP_URL=http://localhost:8080
# 文件上传存储目次
VOLUME /webroot/storage/app/public
RUN php artisan config:cache
实行构建
docker build -t my-wizard .
数据库初始化
docker run -it --rm --name my-wizard my-wizard php artisan migrate:install
docker run -it --rm --name my-wizard my-wizard php artisan migrate
运转
docker run -d --name my-wizard -p 8080:80 my-wizard
然后就可以经过 http://localhost:8080 拜候 Wizard 了。
总结
Wizard是一个值得使用的文档办理体系,独立摆设,支持MD、Swagger、Table以及别的很多实用的功效,假如你正必要如此一个体系,那么Wizard将是一个不错的选择!