前段時間阿里正式發(fā)布了語雀郁岩,不得不說婿奔,在團(tuán)隊文檔管理方面,語雀的用戶體驗確實做得非常不錯问慎。趁著這個熱度萍摊,當(dāng)時就想給我在2017年開源的 Wizard 項目寫一篇文章,大概介紹一下 Wizard 支持的功能如叼。但無奈剛好那段時間工作太忙冰木,一直沒有時間來好好梳理一下。
概述
Wizard 是一款開源的文檔管理系統(tǒng)笼恰,支持 Markdown 文檔踊沸,Swagger 文檔以及表格文檔,適應(yīng)于中小規(guī)模的技術(shù)團(tuán)隊文檔管理社证,完全免費(fèi)逼龟。Wizard 并不是一款云產(chǎn)品,不提供任何云服務(wù)追葡,如果你的團(tuán)隊想要使用他腺律,你必須在自己公司內(nèi)部獨(dú)立部署。正因為這樣辽俗,你的數(shù)據(jù)和技術(shù)文檔安全是有保障的疾渣,不會泄露給任何不信任的第三方。
更新內(nèi)容
由于上次寫文章來介紹 Wizard 是發(fā)布 1.0 版本崖飘,因此這里就把從 1.0 到 1.2 的所有主要更新內(nèi)容都列出來了榴捡。
- 增加 黑暗主題 的支持,你可以自由切換兩款主題
- 在 Markdown 模式下朱浴,實現(xiàn)了對 mermaid 繪制流程圖吊圾,序列圖,餅圖翰蠢,類圖项乒,狀態(tài)圖等各種圖表的支持。 查看使用說明
- 在 Markdown 模式下梁沧,增加了對數(shù)據(jù)庫數(shù)據(jù)結(jié)構(gòu)展示卡片的支持檀何,現(xiàn)在,你可以直接將 SQL 建表語句放置在代碼塊中,Wizard 將會為你轉(zhuǎn)換為表格展示频鉴。 查看使用說明
- 實現(xiàn)跨項目移動文檔功能
- 文檔導(dǎo)出功能栓辜,支持單個或者批量導(dǎo)出 PDF 或者 Markdown 文檔
- 增加“項目目錄是否在首頁展示”的支持,現(xiàn)在垛孔,你可以控制首頁展示哪些項目目錄了藕甩,參考 在首頁隱藏項目目錄
- 表格類型文檔 完善,現(xiàn)在作為正式功能周荐,去掉 beta 標(biāo)識
- 文檔差異對比 優(yōu)化狭莱,文檔差異對比更加清晰
- Markdown 文檔展示優(yōu)化,展示效果更加友好概作,新建文檔使用最新的 markdown 解釋器腋妙,修復(fù)了之前的一些 bug
- Markdown 增加 框架頁展示 支持
更多功能更新參考項目的 Releases 頁面。
功能概覽
項目的地址為
https://github.com/mylxsw/wizard
作為一款開源的文檔管理系統(tǒng)仆嗦,Wizard 主要支持下面這些功能
- 文檔管理
- Markdown 文檔管理辉阶,支持各種功能擴(kuò)展(流程圖,LaTex瘩扼,數(shù)據(jù)結(jié)構(gòu)等)
- Swagger API 文檔管理
- 表格 文檔管理(類似于簡化版的在線 Excel)
- 用戶權(quán)限
- 類似于 Gitlab 的權(quán)限管理體系,你可以建立用戶組垃僚,為一組用戶分配項目的讀寫權(quán)限
- 基于 LDAP 的統(tǒng)一身份認(rèn)證(LDAP/活動目錄)集绰,你可以將其接入到公司統(tǒng)一的賬戶管理體系,只需要修改幾行配置
- 文檔評論
- 文檔變更歷史谆棺,文檔變更差異對比
- 多主題自由切換
- 項目分組栽燕,你可以將一些相關(guān)聯(lián)的項目組成一個組,方便更快的檢索文檔
- 其它
- 文檔附件
- 文檔分享
- 閱讀模式
- 內(nèi)容模板
- 文檔搜索
- 等等
你可以訪問 http://wizard.aicode.cc/ 在線體驗 Wizard 的功能改淑。
在線版本的 Wizard 由于服務(wù)器配置比較低碍岔,訪問可能會比較慢,而且權(quán)限比較開放朵夏,任何人都可以編輯蔼啦,內(nèi)容比較亂一些。
部分功能展示
Markdown 文檔展示
Swagger 文檔展示
表格文檔展示
文檔差異對比
更多功能展示請查看項目的 Wiki 文檔仰猖。
關(guān)于代碼
項目采用了 Laravel 框架開發(fā)捏肢,目前版本已經(jīng)升級到 5.8(最開始為5.4,一路升級過來)饥侵。為了提高開發(fā)效率鸵赫,保持架構(gòu)的簡潔,在開發(fā)過程中躏升,一直避免引入過多的外部組件辩棒,盡可能的利用 Laravel 提供的各種組件,比如 Authentication,Authorization一睁,Events藕赞,Mail,Notifications 等卖局,非常適合用來學(xué)習(xí) Laravel 框架斧蜕。
總結(jié)
如果你在為公司尋找一款開源免費(fèi)的 開發(fā)文檔/API文檔管理 工具,不妨考慮一下 Wizard 項目(多一個選擇砚偶,為什么不嘗試下呢)批销,一定不會讓你失望的。如果你是一名 PHP 或者 Laravel 新手染坯,想找個項目學(xué)習(xí)一下如何用 Laravel 做 Web 開發(fā)均芽,這個項目更加不能錯過!
最后单鹿,趕緊去 Star 一波掀宋,順便給我個 Star ,你的支持是我堅持下去的動力 仲锄!如果再能貢獻(xiàn)點(diǎn) Issues 或者 PR劲妙,那就更好啦 ??!