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