Wizard 是一款开源文档管理系统,项目地址为 https://github.com/mylxsw/wizard。这个项目是 我 在2017年就开始开发的,起初只是想作一款可以在公司内部把Swagger文档管理起来的工具,但在这近两年的时间里,一直断断续续的为其添加各类功能,如今终于下决心发布1.0版本了,目前支持三种类型的文档管理laravel
目前主要包含如下功能git
若是想快速体验一下Wizard的功能,有两种方式github
进入项目的根目录,执行 docker-compose up
,就能够快速建立一个Wizard服务了,访问地址 http://localhost:8080 。docker
为了鼓励你们写开发文档,最开始咱们选择了 ShowDoc 项目来做为文档管理工具,当时团队规模也很是的小,你们都是直接用 Markdown 写一些简单的开发文档。后来随着团队的壮大,先后端分离,团队分工的细化,仅仅采用 Markdown 开始变得捉襟见肘,这时候,咱们首先想到了使用开源界比较流行的 Swagger 来建立开发文档。可是 Swagger 文档多了,总得有个地方维护起来吧?数据库
项目中的文档仅仅用Swagger也是不够的,它只适应于API文档的管理,还有不少其它文档,好比设计文档,流程图,架构文档,技术方案,数据库变动等各类文档须要一块儿维护起来。所以,我决定利用业余时间开发一款 支持 Markdown 和 Swagger 的文档管理工具,也就是 Wizard 项目了。后端
起初打算用 Go 语言来开发,可是没过几天发现使用 Golang 来作 Web 项目开发效率过低(快速开发效率,并不是指性能,Golang作API接口开发仍是很不错的),不少经常使用的功能都须要本身去实现,遂放弃使用 Golang,转而使用 PHP 的 Laravel 框架来开发。因此虽然项目建立的时间为 2017年7月27日,可是实际上真正开始的时间应该算是 2017年7月31日。架构
起初Wizard项目的想法比较简单,只是用来将 Markdown 文档和 Swagger 文档放在一块儿,提供一个简单的管理界面就足够了,可是随着在团队中展开使用后,发如今企业中做为一款文档管理工具来讲,只提供简单的文档管理功能是不够的,好比说权限控制,文档修改历史,文档搜索,文档分类等功能需求不断的被提出来,所以也促成了 Wizard 项目的功能愈来愈完善。框架
项目采用了 Laravel 框架开发,目前版本已经升级到最新的 5.8(最开始为5.4,一路升级过来)。为了提升开发效率,保持架构的简洁,在开发过程当中,一直避免引入过多的外部组件,尽量的利用 Laravel 提供的各类组件,好比 Authentication,Authorization,Events,Mail,Notifications 等,很是适合用来学习 Laravel 框架。前后端分离
若是你在为公司寻找一款开源免费的 开发文档/API文档管理 工具,不妨考虑一下 Wizard 项目,必定不会让你失望的。若是你是一名 PHP 或者 Laravel 新手,想找个项目学习一下如何用 Laravel 作 Web 开发,这个项目更加不能错过!编辑器
最后,也是本文最核心的部分,赶忙去 Star 一下,顺便给我个 Star 啊 !若是再能贡献点 Issues 或者P R,那就更好啦 😄!