Wizard是一款為技術(shù)團(tuán)隊(duì)提供的API文檔管理工具,一個(gè)團(tuán)隊(duì)的開發(fā)效率跟團(tuán)隊(duì)文檔的管理還是有很大關(guān)系的,像一些大公司的技術(shù)團(tuán)隊(duì)都是有相當(dāng)豐富的文檔管理經(jīng)驗(yàn)的。這款Wizard可以讓你免費(fèi)部署,它并不是一款云文檔管理,你不用擔(dān)心技術(shù)文檔泄露。
支持文檔類型:
Markdown:也是Wizard最主要的文檔類型,研發(fā)團(tuán)隊(duì)日常工作中交流所采用的最常用文檔類型,在 Wizard 中,對(duì) Editor.md 項(xiàng)目進(jìn)行了功能擴(kuò)展,增加了文檔模板,Json 轉(zhuǎn)表格,圖片粘貼上傳等功能
Swagger:支持 OpenAPI 3.0 規(guī)范,集成了 Swagger 官方的編輯器,支持文檔模板,全屏編輯,文檔自動(dòng)同步功能
Table:這種文檔類型是類似于 Excel 電子表格,集成了 x-spreadsheet 項(xiàng)目
更新內(nèi)容:
v1.2.0
新增 暗色風(fēng)格 主題模式,頁(yè)面部分細(xì)節(jié),樣式效果微調(diào)
表格類型文檔 完善,現(xiàn)在作為正式功能,去掉 beta 標(biāo)識(shí)
文檔差異對(duì)比 優(yōu)化,文檔差異對(duì)比更加清晰
Markdown 文檔展示優(yōu)化,展示效果更加友好,新建文檔使用最新的 markdown 解釋器,修復(fù)了之前的一些 bug
Markdown 增加 框架頁(yè)展示 支持
項(xiàng)目及文檔頁(yè)面?zhèn)冗厵谠黾诱郫B支持
主要功能:
Swagger,Markdown,Table 類型的文檔管理
文檔修改歷史管理
文檔修改差異對(duì)比
用戶權(quán)限管理
項(xiàng)目分組管理
LDAP 統(tǒng)一身份認(rèn)證
文檔搜索,標(biāo)簽搜索
閱讀模式
文檔評(píng)論
消息通知
文檔分享
統(tǒng)計(jì)功能
流程圖,序列圖,餅圖,Tex LaTex 科學(xué)公式支持
多主題切換
安裝說明:
目前支持兩種安裝方式,如果你熟悉Docker,可以直接使用Docker容器的方式來運(yùn)行該項(xiàng)目,這也是最簡(jiǎn)單的方式了。如果你沒有使用Docker或者不知道什么是Docker,那么請(qǐng)直接參考手動(dòng)安裝部分。