使用的技术(TODO: 最新技术栈整理中，使用的第三方库升级中)

MinDoc 简介

MinDoc 是一款针对IT团队开发的简单好用的文档管理系统。

MinDoc 的前身是 SmartWiki 文档系统。SmartWiki 是基于 PHP 框架 laravel 开发的一款文档管理系统。因 PHP 的部署对普通用户来说太复杂，所以改用 Golang 开发。可以方便用户部署和实用。

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

可以用来储存日常接口文档，数据库字典，手册说明等文档。内置项目管理，用户管理，权限管理等功能，能够满足大部分中小团队的文档管理需求。

演示站点:

开发&维护&使用 悉知

感谢作者 lifei6671 创造了MinDoc，并持续维护了很久。

作者因工作等原因，精力有限，无法花费足够的时间来持续维护mindoc，已于北京时间2021年3月23日将mindoc交给社区(github组织mindoc-org)维护，期待热心开发者加入mindoc-org一起来维护MinDoc。

1051164153

对开发感兴趣请关注 Development:

安装与使用

如果你的服务器上没有安装golang程序请手动设置一个环境变量如下：键名为 ZONEINFO，值为MinDoc跟目录下的/lib/time/zoneinfo.zip 。

更多信息请查看手册： MinDoc 使用手册

对于没有Golang使用经验的用户，可以从 https://github.com/mindoc-org/mindoc/releases 这里下载编译完的程序。

CGOgo mod

utf8mb4_general_ciconf/app.conf

SQLite

app.confapp.conf.exampleapp.conf

默认程序会自动初始化一个超级管理员用户：admin 密码：123456 。请登录后重新设置密码。

使用Docker部署

如果是Docker用户，可参考项目内置的Dockerfile文件自行编译镜像(编译命令见Dockerfile文件底部注释，仅供参考)。

conf/app.conf.example

Windows

Linux、Mac

举个栗子-更多环境变量示例(镜像已过期，仅供参考，请以当前镜像为准)

docker-compose 一键安装

docker-compose.ymlvolumesenvironment

项目截图

创建项目

项目列表

项目概述

项目成员

项目设置

基于Editor.md开发的Markdown编辑器

基于wangEditor开发的富文本编辑器

项目预览

超级管理员后台

使用的技术(TODO: 最新技术栈整理中，使用的第三方库升级中)

• Beego 1.10.0
• MySQL 5.6
• editor.md Markdown 编辑器
• WebUploader 文件上传框架
• jsTree 树状结构库
• Cropper 图片剪裁库
• layer 弹出层框架
• highlight.js 代码高亮库
• to-markdownTurndown HTML转Markdown库
• quill 富文本编辑器
• wangEditor 富文本编辑器
• Vue.js 框架

主要功能

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

参与开发

我们欢迎您在 MinDoc 项目的 GitHub 上报告 issue 或者 pull request。

如果您还不熟悉GitHub的Fork and Pull开发模式，您可以阅读GitHub的文档（https://help.github.com/articles/using-pull-requests） 获得更多的信息。

关于作者

一个不纯粹的PHPer，一个不自由的 gopher 。