V2EX = way to explore
V2EX 是一个关于分享和探索的地方
现在注册
已注册用户请  登录
爱意满满的作品展示区。
mylxsw
V2EX  ›  分享创造

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

  •  
  •   mylxsw ·
    mylxsw · 2020-03-03 15:42:33 +08:00 · 3258 次点击
    这是一个创建于 1757 天前的主题,其中的信息可能已经有所发展或是发生改变。

    概述

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

    Wizard-功能预览图

    更新内容

    本次更新( 1.2.1 )主要包含以下内容

    • 文档预览( Markdown/Swagger )增加了对黑暗主题模式的支持,切换到黑暗模式之后,你的文档也将以黑暗色调展示
    • Table 类型的文档现在支持同一个单元格换行展示,操作方式与 Excel 相同,使用 Alt + Enter 换行
    • Table 类型的文档现在支持从 Excel 文档粘贴复制内容了,感谢 x-spreadsheet 的更新支持
    • Markdown 文档中增加了对思维导图嵌入的支持,该功能还不太完善,目前处于 beta 状态
    • 静态资源 CDN 支持,静态资源可以使用七牛云的 CDN 加速,减少应用带宽消耗

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

    功能概览

    项目的地址为

    https://github.com/mylxsw/wizard
    

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

    • 文档管理
      • Markdown 文档管理,支持各种功能扩展(流程图,LaTex,数据结构等)
      • Swagger API 文档管理
      • 表格 文档管理(类似于简化版的在线 Excel)
    • 用户权限
      • 类似于 Gitlab 的权限管理体系,你可以建立用户组,为一组用户分配项目的读写权限
      • 基于 LDAP 的统一身份认证( LDAP/活动目录),你可以将其接入到公司统一的账户管理体系,只需要修改几行配置
    • 文档评论
    • 文档变更历史,文档变更差异对比
    • 多主题自由切换
    • 项目分组,你可以将一些相关联的项目组成一个组,方便更快的检索文档
    • 其它
      • 文档附件
      • 文档分享
      • 阅读模式
      • 内容模板
      • 文档搜索
      • 等等

    你可以访问 http://wizard.aicode.cc/ 在线体验 Wizard 的功能。

    在线版本的 Wizard 由于服务器配置比较低,访问可能会比较慢,而且权限比较开放,任何人都可以编辑,内容比较乱一些。

    部分功能展示

    Markdown 文档展示

    Swagger 文档展示

    黑暗主题模式

    -w1131

    表格文档展示

    文档差异对比

    更多功能展示请查看项目的 Wiki 文档

    关于代码

    项目采用了 Laravel 框架开发,目前版本已经升级到 5.8 (最开始为 5.4,一路升级过来)。为了提高开发效率,保持架构的简洁,在开发过程中,一直避免引入过多的外部组件,尽可能的利用 Laravel 提供的各种组件,比如 AuthenticationAuthorizationEventsMailNotifications 等,非常适合用来学习 Laravel 框架。

    总结

    如果你在为公司寻找一款开源免费的 开发文档 /API 文档管理 工具,不妨考虑一下 Wizard 项目(多一个选择,为什么不尝试下呢),一定不会让你失望的。如果你是一名 PHP 或者 Laravel 新手,想找个项目学习一下如何用 Laravel 做 Web 开发,这个项目更加不能错过!

    最后,赶紧去 Star 一波,顺便给我个 Star ,你的支持是我坚持下去的动力 !如果再能贡献点 Issues 或者 PR,那就更好啦 😄!

    4 条回复    2020-03-04 14:21:59 +08:00
    maskerTUI
        1
    maskerTUI  
       2020-03-03 16:01:21 +08:00
    挺好看的,不过公司已经在用 jira 了
    arlicle
        2
    arlicle  
       2020-03-03 19:47:20 +08:00
    @maskerTUI @mylxsw
    邀请你体验一下我开发的这个,也是开发文档和 API 文档管理工具,更简单易用。
    github 搜索 arlicle/panda-api

    1、安装敲简单、敲容易,支持 Windows、Linux、Mac 一键安装使用。一个命令就运行。无需编译、不用数据库,不用服务器环境。
    2、使用超简单,使用 json5 语法编写接口,一个命令就可以在线浏览文档,在线请求接口服务。
    2、自动生成接口文档
    3、自动为前端提供接口服务
    4、自动生成 mock 数据,mock 数据生成 支持 array、object、map、递归 复杂数据结构
    5、使用 git 进行版本管理和团队协作,通过 git,你可以看到每次接口什么人修改了什么地方
    6、接口可以继承、可以部分重写,写起来非常高效
    7、支持纯 markdown 文档,可以轻松写出像微信公众号开发文档一样的接口文档
    8、使用你最喜欢的编辑器进行文档编写(我敲不喜欢 UI 操作)
    charlestang
        3
    charlestang  
       2020-03-04 10:52:06 +08:00
    我现在发现,各种 Markdown 制作 目录都极其困难,一个是不自动生成目录,手动生成的话,制作网页内锚点链接也极其困难。不知道你这个怎么解决的。
    mylxsw
        4
    mylxsw  
    OP
       2020-03-04 14:21:59 +08:00
    @charlestang 使用标记 [TOC] 就可以自动生成目录
    关于   ·   帮助文档   ·   博客   ·   API   ·   FAQ   ·   实用小工具   ·   1051 人在线   最高记录 6679   ·     Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 · 31ms · UTC 20:07 · PVG 04:07 · LAX 12:07 · JFK 15:07
    Developed with CodeLauncher
    ♥ Do have faith in what you're doing.