前段時(shí)間阿里正式發(fā)布了語雀，不得不說，在團(tuán)隊(duì)文檔管理方面，語雀的用戶體驗(yàn)確實(shí)做得非常不錯(cuò)。趁著這個(gè)熱度，當(dāng)時(shí)就想給我在2017年開源的 Wizard 項(xiàng)目寫一篇文章，大概介紹一下 Wizard 支持的功能。但無奈剛好那段時(shí)間工作太忙，一直沒有時(shí)間來好好梳理一下。

概述

Wizard 是一款開源的文檔管理系統(tǒng)，支持 Markdown 文檔，Swagger 文檔以及表格文檔，適應(yīng)于中小規(guī)模的技術(shù)團(tuán)隊(duì)文檔管理，完全免費(fèi)。Wizard 并不是一款云產(chǎn)品，不提供任何云服務(wù)，如果你的團(tuán)隊(duì)想要使用他，你必須在自己公司內(nèi)部獨(dú)立部署。正因?yàn)檫@樣，你的數(shù)據(jù)和技術(shù)文檔安全是有保障的，不會(huì)泄露給任何不信任的第三方。

更新內(nèi)容

由于上次寫文章來介紹 Wizard 是發(fā)布 1.0 版本，因此這里就把從 1.0 到 1.2 的所有主要更新內(nèi)容都列出來了。

• 增加 黑暗主題 的支持，你可以自由切換兩款主題
• 在 Markdown 模式下，實(shí)現(xiàn)了對(duì) mermaid 繪制流程圖，序列圖，餅圖，類圖，狀態(tài)圖等各種圖表的支持。 查看使用說明
• 在 Markdown 模式下，增加了對(duì)數(shù)據(jù)庫數(shù)據(jù)結(jié)構(gòu)展示卡片的支持，現(xiàn)在，你可以直接將 SQL 建表語句放置在代碼塊中，Wizard 將會(huì)為你轉(zhuǎn)換為表格展示。 查看使用說明
• 實(shí)現(xiàn)跨項(xiàng)目移動(dòng)文檔功能
• 文檔導(dǎo)出功能，支持單個(gè)或者批量導(dǎo)出 PDF 或者 Markdown 文檔
• 增加“項(xiàng)目目錄是否在首頁展示”的支持，現(xiàn)在，你可以控制首頁展示哪些項(xiàng)目目錄了，參考 在首頁隱藏項(xiàng)目目錄
• 表格類型文檔?完善，現(xiàn)在作為正式功能，去掉 beta 標(biāo)識(shí)
• 文檔差異對(duì)比?優(yōu)化，文檔差異對(duì)比更加清晰
• Markdown 文檔展示優(yōu)化，展示效果更加友好，新建文檔使用最新的 markdown 解釋器，修復(fù)了之前的一些 bug
• Markdown 增加?框架頁展示?支持

更多功能更新參考項(xiàng)目的 Releases 頁面。

功能概覽

項(xiàng)目的地址為

https://github.com/mylxsw/wizard

作為一款開源的文檔管理系統(tǒng)，Wizard 主要支持下面這些功能

• 文檔管理

  • Markdown 文檔管理，支持各種功能擴(kuò)展（流程圖，LaTex，數(shù)據(jù)結(jié)構(gòu)等）
  • Swagger API 文檔管理
  • 表格 文檔管理（類似于簡化版的在線 Excel)

• 用戶權(quán)限

  • 類似于 Gitlab 的權(quán)限管理體系，你可以建立用戶組，為一組用戶分配項(xiàng)目的讀寫權(quán)限
  • 基于 LDAP 的統(tǒng)一身份認(rèn)證（LDAP/活動(dòng)目錄），你可以將其接入到公司統(tǒng)一的賬戶管理體系，只需要修改幾行配置
• 文檔評(píng)論
• 文檔變更歷史，文檔變更差異對(duì)比
• 多主題自由切換
• 項(xiàng)目分組，你可以將一些相關(guān)聯(lián)的項(xiàng)目組成一個(gè)組，方便更快的檢索文檔

• 其它

  • 文檔附件
  • 文檔分享
  • 閱讀模式
  • 內(nèi)容模板
  • 文檔搜索
  • 等等

你可以訪問 http://wizard./ 在線體驗(yàn) Wizard 的功能。

在線版本的 Wizard 由于服務(wù)器配置比較低，訪問可能會(huì)比較慢，而且權(quán)限比較開放，任何人都可以編輯，內(nèi)容比較亂一些。

部分功能展示

Markdown 文檔展示

Swagger 文檔展示

表格文檔展示

文檔差異對(duì)比

更多功能展示請(qǐng)查看項(xiàng)目的 Wiki 文檔。

關(guān)于代碼

項(xiàng)目采用了 Laravel 框架開發(fā)，目前版本已經(jīng)升級(jí)到 5.8（最開始為5.4，一路升級(jí)過來）。為了提高開發(fā)效率，保持架構(gòu)的簡潔，在開發(fā)過程中，一直避免引入過多的外部組件，盡可能的利用 Laravel 提供的各種組件，比如 Authentication，Authorization，Events，Mail，Notifications 等，非常適合用來學(xué)習(xí) Laravel 框架。

總結(jié)

如果你在為公司尋找一款開源免費(fèi)的 開發(fā)文檔/API文檔管理 工具，不妨考慮一下 Wizard 項(xiàng)目（多一個(gè)選擇，為什么不嘗試下呢），一定不會(huì)讓你失望的。如果你是一名 PHP 或者 Laravel 新手，想找個(gè)項(xiàng)目學(xué)習(xí)一下如何用 Laravel 做 Web 開發(fā)，這個(gè)項(xiàng)目更加不能錯(cuò)過！

最后，趕緊去 Star 一波，順便給我個(gè) Star ，你的支持是我堅(jiān)持下去的動(dòng)力 ！如果再能貢獻(xiàn)點(diǎn) Issues 或者 PR，那就更好啦 ?！