Hi！大家好呀！我是你們努力的喵哥！
你們自己的文檔是怎么管理那？有沒(méi)有各個(gè)文件到處亂放？有沒(méi)有到處云盤(pán)備份？是不是經(jīng)常想找某個(gè)文檔的時(shí)候找不到了？
近兩年知識(shí)庫(kù)的概念特別火。這些所謂的知識(shí)，大多數(shù)都會(huì)沉淀成為文檔。因此，我們文檔就是我們珍貴的知識(shí)。特別是我們的技術(shù)文檔。我們還是要好好管理起來(lái)的。
所以，今天喵哥就給大家推薦這款文檔管理的開(kāi)源項(xiàng)目 Wizard。拯救你亂糟糟的零散文檔。
Wizard 與 ShowDoc 比較類(lèi)似。但是 Wizard 更適用于技術(shù)人員一些。特別是中等規(guī)模的團(tuán)隊(duì)，Wizard 可以集成各類(lèi)其它文檔。但相較于語(yǔ)雀等成熟的商業(yè)知識(shí)庫(kù)管理軟件，設(shè)計(jì)和功能上還是有所差距。但是 Wizard 是完全免費(fèi)，且可以自由私有部署。
目前 Wizard 主要包含以下功能：
Swagger，Markdown，Table 類(lèi)型的文檔管理
文檔修改歷史管理
文檔修改差異對(duì)比
用戶(hù)權(quán)限管理
項(xiàng)目分組管理
LDAP 統(tǒng)一身份認(rèn)證
文檔搜索，標(biāo)簽搜索
閱讀模式
文檔評(píng)論
消息通知
文檔分享
統(tǒng)計(jì)功能
流程圖，序列圖，餅圖，Tex LaTex 科學(xué)公式支持
多主題切換
安裝
目前支持兩種安裝方式，如果你熟悉Docker，可以直接使用Docker容器的方式來(lái)運(yùn)行該項(xiàng)目，這也是最簡(jiǎn)單的方式了。如果你沒(méi)有使用Docker或者不知道什么是Docker，那么請(qǐng)直接參考手動(dòng)安裝部分。
通過(guò) Docker 安裝
詳細(xì)安裝方法參考 Docker Hub mylxsw/wizard。
方法一
首先對(duì)于新安裝用戶(hù)，需要執(zhí)行數(shù)據(jù)庫(kù)的初始化
docker run -it --rm --name wizard \-e DB_HOST=host.docker.internal \-e DB_PORT=3306 \-e DB_DATABASE=wizard \-e DB_USERNAME=wizard \-e DB_PASSWORD=wizard \???? mylxsw/wizard?初始化命令
這里的 初始化命令 包含兩個(gè)，依次執(zhí)行即可
php artisan migrate:installphp artisan migrate
最后，直接運(yùn)行下面的 Docker 命令即可
docker run -d --name wizard \-e DB_HOST=host.docker.internal \-e DB_PORT=3306 \-e DB_DATABASE=wizard \-e DB_USERNAME=wizard \-e DB_PASSWORD=wizard \-p 8080:80 \-v /Users/mylxsw/Downloads:/webroot/storage/app/public \mylxsw/wizard
簡(jiǎn)要說(shuō)明：
- -e 指定配置，用環(huán)境變量的形式覆蓋 .env 中的配置
- -d 后臺(tái)模式運(yùn)行
- -p 指定映射容器內(nèi)的80端口為宿主機(jī)的 8080 端口，這樣就可以在宿主機(jī)上以 http://localhost:8080 的形式訪問(wèn)了
- -v 映射數(shù)據(jù)目錄位置，將本地目錄映射到文件上傳存儲(chǔ)目錄，避免重啟服務(wù)時(shí)圖片等數(shù)據(jù)丟失
在使用 Docker 模式啟動(dòng)后，如果啟動(dòng)后訪問(wèn)頁(yè)面報(bào)錯(cuò) 500，可以在啟動(dòng)命令中添加 -e APP_DEBUG=true 來(lái)啟用 DEBUG 模式，在訪問(wèn)的時(shí)候就可以看到詳細(xì)的報(bào)錯(cuò)信息了。
方法二
我們需要?jiǎng)?chuàng)建一個(gè)Dockerfile，在Dockerfile中添加環(huán)境配置，比如我采用了宿主機(jī)上安裝的MySQL服務(wù)器，就有了下面的這段Dockerfile配置
FROM mylxsw/wizard:latest# 數(shù)據(jù)庫(kù)連接配置# 這里可以根據(jù)需要添加其它的Env配置，可用選項(xiàng)參考項(xiàng)目的.env.example文件ENV DB_CONNECTION=mysqlENV DB_HOST=host.docker.internalENV DB_PORT=3306ENV DB_DATABASE=wizard_2ENV DB_USERNAME=wizardENV DB_PASSWORD=wizardENV WIZARD_NEED_ACTIVATE=false# 訪問(wèn)地址，只有正確配置后，導(dǎo)出的 markdown 文檔圖片才能正常展示ENV APP_URL=http://localhost:8080# 文件上傳存儲(chǔ)目錄VOLUME /webroot/storage/app/publicRUN php artisan config:cache
執(zhí)行構(gòu)建
docker build -t my-wizard數(shù)據(jù)庫(kù)初始化
docker run -it --rm --name my-wizard my-wizard php artisan migrate:installdocker run -it --rm --name my-wizard my-wizard php artisan migrate
運(yùn)行
docker run -d --name my-wizard -p 8080:80 my-wizard然后就可以通過(guò) http://localhost:8080 訪問(wèn) Wizard 了。
最后
Wizard 的作者是 mylxsw，且共有三位貢獻(xiàn)者。Wizard 在 Github 上收獲了923 Star。雖然，項(xiàng)目的 Star 的不多，但作者已維護(hù)項(xiàng)目三年多了，而且還在不斷的迭代更新中。喵哥，在搭建 Wizard 并在團(tuán)隊(duì)推廣后，已沉淀了上百份文檔。
項(xiàng)目地址：https://github.com/mylxsw/wizard
在線(xiàn)體驗(yàn)：http://wizard.aicode.cc/
