开源文档管理系统 Wizard 1.2 发布

前段时间阿里正式发布了语雀,不得不说,在团队文档管理方面,语雀的用户体验确实做得非常不错。趁着这个热度,当时就想给我在2017年开源的 Wizard 项目写一篇文章,大概介绍一下 Wizard 支持的功能。但无奈刚好那段时间工作太忙,一直没有时间来好好梳理一下。

概述

Wizard 是一款开源的文档管理系统,支持 Markdown 文档,Swagger 文档以及表格文档,适应于中小规模的技术团队文档管理,完全免费。Wizard 并不是一款云产品,不提供任何云服务,如果你的团队想要使用他,你必须在自己公司内部独立部署。正因为这样,你的数据和技术文档安全是有保障的,不会泄露给任何不信任的第三方。

Wizard-功能预览图

更新内容

由于上次写文章来介绍 Wizard 是发布 1.0 版本,因此这里就把从 1.0 到 1.2 的所有主要更新内容都列出来了。

  • 增加 黑暗主题 的支持,你可以自由切换两款主题
  • 在 Markdown 模式下,实现了对 mermaid 绘制流程图,序列图,饼图,类图,状态图等各种图表的支持。 查看使用说明
  • 在 Markdown 模式下,增加了对数据库数据结构展示卡片的支持,现在,你可以直接将 SQL 建表语句放置在代码块中,Wizard 将会为你转换为表格展示。 查看使用说明
  • 实现跨项目移动文档功能
  • 文档导出功能,支持单个或者批量导出 PDF 或者 Markdown 文档
  • 增加“项目目录是否在首页展示”的支持,现在,你可以控制首页展示哪些项目目录了,参考 在首页隐藏项目目录
  • 表格类型文档 完善,现在作为正式功能,去掉 beta 标识
  • 文档差异对比 优化,文档差异对比更加清晰
  • Markdown 文档展示优化,展示效果更加友好,新建文档使用最新的 markdown 解释器,修复了之前的一些 bug
  • Markdown 增加 框架页展示 支持

更多功能更新参考项目的 Releases 页面。

功能概览

项目的地址为

https://github.com/mylxsw/wizard

作为一款开源的文档管理系统,Wizard 主要支持下面这些功能

  • 文档管理
    • 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,那就更好啦 😄!

Scroll Up