開源文檔管理系統 Wizard 1.2 發佈

前段時間阿里正式發佈了語雀,不得不說,在團隊文檔管理方面,語雀的用戶體驗確實作得很是不錯。趁着這個熱度,當時就想給我在2017年開源的 Wizard 項目寫一篇文章,大概介紹一下 Wizard 支持的功能。但無奈恰好那段時間工做太忙,一直沒有時間來好好梳理一下。laravel

概述

Wizard 是一款開源的文檔管理系統,支持 Markdown 文檔,Swagger 文檔以及表格文檔,適應於中小規模的技術團隊文檔管理,徹底免費。Wizard 並非一款雲產品,不提供任何雲服務,若是你的團隊想要使用他,你必須在本身公司內部獨立部署。正由於這樣,你的數據和技術文檔安全是有保障的,不會泄露給任何不信任的第三方。git

Wizard-功能預覽圖

更新內容

因爲上次寫文章來介紹 Wizard 是發佈 1.0 版本,所以這裏就把從 1.0 到 1.2 的全部主要更新內容都列出來了。github

  • 增長 黑暗主題 的支持,你能夠自由切換兩款主題
  • 在 Markdown 模式下,實現了對 mermaid 繪製流程圖,序列圖,餅圖,類圖,狀態圖等各類圖表的支持。 查看使用說明
  • 在 Markdown 模式下,增長了對數據庫數據結構展現卡片的支持,如今,你能夠直接將 SQL 建表語句放置在代碼塊中,Wizard 將會爲你轉換爲表格展現。 查看使用說明
  • 實現跨項目移動文檔功能
  • 文檔導出功能,支持單個或者批量導出 PDF 或者 Markdown 文檔
  • 增長「項目目錄是否在首頁展現」的支持,如今,你能夠控制首頁展現哪些項目目錄了,參考 在首頁隱藏項目目錄
  • 表格類型文檔 完善,如今做爲正式功能,去掉 beta 標識
  • 文檔差別對比 優化,文檔差別對比更加清晰
  • Markdown 文檔展現優化,展現效果更加友好,新建文檔使用最新的 markdown 解釋器,修復了以前的一些 bug
  • Markdown 增長 框架頁展現 支持

更多功能更新參考項目的 Releases 頁面。數據庫

功能概覽

項目的地址爲安全

https://github.com/mylxsw/wizard

做爲一款開源的文檔管理系統,Wizard 主要支持下面這些功能服務器

  • 文檔管理markdown

    • Markdown 文檔管理,支持各類功能擴展(流程圖,LaTex,數據結構等)
    • Swagger API 文檔管理
    • 表格 文檔管理(相似於簡化版的在線 Excel)
  • 用戶權限數據結構

    • 相似於 Gitlab 的權限管理體系,你能夠創建用戶組,爲一組用戶分配項目的讀寫權限
    • 基於 LDAP 的統一身份認證(LDAP/活動目錄),你能夠將其接入到公司統一的帳戶管理體系,只須要修改幾行配置
  • 文檔評論
  • 文檔變動歷史,文檔變動差別對比
  • 多主題自由切換
  • 項目分組,你能夠將一些相關聯的項目組成一個組,方便更快的檢索文檔
  • 其它架構

    • 文檔附件
    • 文檔分享
    • 閱讀模式
    • 內容模板
    • 文檔搜索
    • 等等

你能夠訪問 http://wizard.aicode.cc/ 在線體驗 Wizard 的功能。框架

在線版本的 Wizard 因爲服務器配置比較低,訪問可能會比較慢,並且權限比較開放,任何人均可以編輯,內容比較亂一些。

部分功能展現

Markdown 文檔展現

Swagger 文檔展現

表格文檔展現

文檔差別對比

更多功能展現請查看項目的 Wiki 文檔

關於代碼

項目採用了 Laravel 框架開發,目前版本已經升級到 5.8(最開始爲5.4,一路升級過來)。爲了提升開發效率,保持架構的簡潔,在開發過程當中,一直避免引入過多的外部組件,儘量的利用 Laravel 提供的各類組件,好比 AuthenticationAuthorizationEventsMailNotifications 等,很是適合用來學習 Laravel 框架。

總結

若是你在爲公司尋找一款開源免費的 開發文檔/API文檔管理 工具,不妨考慮一下 Wizard 項目(多一個選擇,爲何不嘗試下呢),必定不會讓你失望的。若是你是一名 PHP 或者 Laravel 新手,想找個項目學習一下如何用 Laravel 作 Web 開發,這個項目更加不能錯過!

最後,趕忙去 Star 一波,順便給我個 Star ,你的支持是我堅持下去的動力 !若是再能貢獻點 Issues 或者 PR,那就更好啦 😄!

相關文章
相關標籤/搜索