你的知识文档早该用这个工具管理了

Hi!大家好呀!我是你们努力的喵哥!

你们自己的文档是怎么管理那?有没有各个文件到处乱放?有没有到处云盘备份?是不是经常想找某个文档的时候找不到了?

近两年知识库的概念特别火。这些所谓的知识,大多数都会沉淀成为文档。因此,我们文档就是我们珍贵的知识。特别是我们的技术文档。我们还是要好好管理起来的。

所以,今天喵哥就给大家推荐这款文档管理的开源项目 Wizard。拯救你乱糟糟的零散文档。

Wizard 与 ShowDoc 比较类似。但是 Wizard 更适用于技术人员一些。特别是中等规模的团队,Wizard 可以集成各类其它文档。但相较于语雀等成熟的商业知识库管理软件,设计和功能上还是有所差距。但是 Wizard 是完全免费,且可以自由私有部署。

目前 Wizard 主要包含以下功能:

Swagger,Markdown,Table 类型的文档管理

文档修改历史管理

文档修改差异对比

用户权限管理

项目分组管理

LDAP 统一身份认证

文档搜索,标签搜索

阅读模式

文档评论

消息通知

文档分享

统计功能

流程图,序列图,饼图,Tex LaTex 科学公式支持

多主题切换

安装

目前支持两种安装方式,如果你熟悉Docker,可以直接使用Docker容器的方式来运行该项目,这也是最简单的方式了。如果你没有使用Docker或者不知道什么是Docker,那么请直接参考手动安装部分。

通过 Docker 安装

详细安装方法参考 Docker Hub mylxsw/wizard。

方法一

首先对于新安装用户,需要执行数据库的初始化

  • 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 初始化命令

    这里的 初始化命令 包含两个,依次执行即可

  • php artisan migrate:installphp artisan migrate

    最后,直接运行下面的 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

    简要说明:

    - -e 指定配置,用环境变量的形式覆盖 .env 中的配置

    - -d 后台模式运行

    - -p 指定映射容器内的80端口为宿主机的 8080 端口,这样就可以在宿主机上以 http://localhost:8080 的形式访问了

    - -v 映射数据目录位置,将本地目录映射到文件上传存储目录,避免重启服务时图片等数据丢失

    在使用 Docker 模式启动后,如果启动后访问页面报错 500,可以在启动命令中添加 -e APP_DEBUG=true 来启用 DEBUG 模式,在访问的时候就可以看到详细的报错信息了。

    方法二

    我们需要创建一个Dockerfile,在Dockerfile中添加环境配置,比如我采用了宿主机上安装的MySQL服务器,就有了下面的这段Dockerfile配置

  • FROM mylxsw/wizard:latest# 数据库连接配置# 这里可以根据需要添加其它的Env配置,可用选项参考项目的.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# 访问地址,只有正确配置后,导出的 markdown 文档图片才能正常展示ENV APP_URL=http://localhost:8080# 文件上传存储目录VOLUME /webroot/storage/app/publicRUN php artisan config:cache

    执行构建

  • docker build -t my-wizard

    数据库初始化

  • docker run -it --rm --name my-wizard my-wizard php artisan migrate:installdocker run -it --rm --name my-wizard my-wizard php artisan migrate

    运行

  • docker run -d --name my-wizard -p 8080:80  my-wizard

    然后就可以通过 http://localhost:8080 访问 Wizard 了。

    最后

    Wizard 的作者是 mylxsw,且共有三位贡献者。Wizard 在 Github 上收获了923 Star。虽然,项目的 Star 的不多,但作者已维护项目三年多了,而且还在不断的迭代更新中。喵哥,在搭建 Wizard 并在团队推广后,已沉淀了上百份文档。

    项目地址:https://github.com/mylxsw/wizard

    在线体验:http://wizard.aicode.cc/


  • ©著作权归作者所有,转载或内容合作请联系作者
    • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
      沈念sama阅读 217,826评论 6 506
    • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
      沈念sama阅读 92,968评论 3 395
    • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
      开封第一讲书人阅读 164,234评论 0 354
    • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
      开封第一讲书人阅读 58,562评论 1 293
    • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
      茶点故事阅读 67,611评论 6 392
    • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
      开封第一讲书人阅读 51,482评论 1 302
    • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
      沈念sama阅读 40,271评论 3 418
    • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
      开封第一讲书人阅读 39,166评论 0 276
    • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
      沈念sama阅读 45,608评论 1 314
    • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
      茶点故事阅读 37,814评论 3 336
    • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
      茶点故事阅读 39,926评论 1 348
    • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
      沈念sama阅读 35,644评论 5 346
    • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
      茶点故事阅读 41,249评论 3 329
    • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
      开封第一讲书人阅读 31,866评论 0 22
    • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
      开封第一讲书人阅读 32,991评论 1 269
    • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
      沈念sama阅读 48,063评论 3 370
    • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
      茶点故事阅读 44,871评论 2 354