乐于分享
好东西不私藏

国产开源,一款针对IT团队开发的文档管理神器!

国产开源,一款针对IT团队开发的文档管理神器!

你是否也经历过这样的场景?团队的接口文档散落在十几个微信群里,翻找时宛如大海捞针;项目的数据库字典,每个开发人员电脑里都存着一个版本,却永远对不上号;新同事入职,面对一堆零散的Word、Excel和过时的Confluence页面,一脸茫然。

今天,给大家推荐一款针对IT团队开发的简单好用的文档管理系统,在GitHub上收获7.8k Star,可以轻松解决上诉痛点问题!

简介

MinDoc是一款界面清晰、功能聚焦的文档平台,可以用来储存日常接口文档,数据库字典,手册说明等文档。内置项目管理,用户管理,权限管理等功能,能够满足大部分中小团队的文档管理需求。

开发缘起是公司IT部门需要一款简单实用的项目接口文档管理和分享的系统。其功能和界面源于 kancloud 。

核心功能

  • 项目管理: 可以对项目进行编辑更改,成员添加,项目排序等。
  • 文档管理: 添加和删除文档等。
  • 评论管理: 可以管理文档评论和自己发布的评论。
  • 用户管理: 添加和禁用用户,个人资料更改等。
  • 用户权限管理: 实现用户角色的变更。
  • 项目加密: 可以设置项目公开状态,私有项目需要通过Token访问。
  • 站点配置: 多语言切换,可开启匿名访问、验证码等。

部署教程

Docker部署最简单方便,我们来看看如何通过Docker部署。

第一步:准备环境

确保你的服务器已安装以下软件:

  • Docker – 版本建议 20.10+
  • Docker Compose – 版本建议 2.0+

可以通过以下命令检查是否安装成功:

docker --versiondocker-compose --version

第二步:创建部署目录并编写配置文件

创建部署目录

mkdir -p /opt/mindoccd /opt/mindoc

创建 Docker Compose 配置文件 使用你喜欢的文本编辑器(如 vim 或 nano)创建 docker-compose.yml 文件:

version:'3'services:mindoc:image:registry.cn-hangzhou.aliyuncs.com/mindoc-org/mindoc:v2.1container_name:mindocrestart:alwaysports:-"8185:8181"volumes:-./conf:/mindoc/conf-./uploads:/mindoc/uploads-./database:/mindoc/databaseenvironment:-MINDOC_RUN_MODE=prod-MINDOC_DB_ADAPTER=sqlite3-MINDOC_DB_DATABASE=./database/mindoc.db

第三步:启动 MinDoc

在 /opt/mindoc 目录下执行:

docker-compose up -d

看到以下输出表示启动成功:

Creating mindoc ... done

第四步:访问与登录

访问地址:http://你的服务器IP:8185

初始账号密码:

  • 用户名:admin
  • 密码:123456

重要提醒:首次登录后,请立即在”系统管理” → “个人资料”中修改密码!

功能预览

  • 创建项目
  • 项目列表
  • 项目概述
  • 项目成员
  • 项目设置
  • 基于Editor.md开发的Markdown编辑器
  • 基于wangEditor开发的富文本编辑器
  • 基于cherryMarkdown开发的编辑器
  • 项目预览
  • 超级管理员后台

开源地址

https://github.com/mindoc-org/mindoc

后端专属技术群

构建高质量的技术交流社群,欢迎从事编程开发、技术招聘HR进群,也欢迎大家分享自己公司的内推信息,相互帮助,一起进步!

文明发言,以交流技术职位内推行业探讨为主

广告人士勿入,切勿轻信私聊,防止被骗

加我好友,拉你进群

点下方的“❤支持我们,非常感谢!

本站文章均为手工撰写未经允许谢绝转载:夜雨聆风 » 国产开源,一款针对IT团队开发的文档管理神器!

评论 抢沙发

3 + 2 =
  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址
×
订阅图标按钮