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,那就更好啦 😄!