开源文档管理系统 MinDoc使用教程
1 MinDoc 介绍
MinDoc 是专为咱们 IT 打工人设计的文档管理系统。它的前身叫
SmartWiki,是用 PHP。但是PHP 部署起来有点小烦,所以用 Golang 重写了一遍,于是 MinDoc 就诞生了。
MinDoc 项目始于公司 IT 部门对简单实用的项目接口文档管理和分享系统的需求。它的功能和界面设计借鉴了知名的在线文档平台 kancloud。MinDoc 可以用来存储日常接口文档、数据库字典、手册说明等各类技术文档。系统内置了项目管理、用户管理、权限管理等功能,能够满足大部分中小团队的文档管理需求。
目前,MinDoc 项目在
GitHub 上已获得了超过 7200 颗星星,项目由
GitHub 组织 mindoc-org 维护。
MinDoc 采用了现代化的技术栈,主要包括:
后端:基于 Golang 的 Beego 框架
数据库:可以选择 MySQL、PostgreSQL 或者 Sqlite
前端:Bootstrap 3.2、jQuery、Vue.js
编辑器:Editor.md(Markdown)、wangEditor (富文本)
其他:WebUploader (文件上传)、jsTree (树状结构)、highlight.js (代码高亮) 等
2 MinDoc 核心功能特性
MinDoc 提供了一系列强大的功能,满足团队文档管理的各种需求:
1.
项目管理
l 创建和管理多个文档项目
l 灵活的项目权限设置
l 项目成员管理
l 项目导出功能 (支持
PDF、Word、Markdown 等格式)
2.
文档编辑
l 支持 Markdown 和富文本两种编辑模式
l 基于 Editor.md 开发的 Markdown 编辑器
l 基于 wangEditor 开发的富文本编辑器
l 文档历史版本管理
l 在线绘图功能 (集成
draw.io)
3.
文档组织
l 树状结构的文档目录
l 文档排序和移动
l 文档搜索功能
4.
协作功能
l 文档评论系统
l 文档分享功能
l 站内消息通知
5.
用户管理
l 用户注册和登录
l 用户角色和权限管理
l 个人资料设置
6.
系统设置
l 站点基本信息配置
l 邮件服务配置
l 主题定制
l 多语言支持
7.
安全特性
l 项目加密功能
l 文档访问授权
l 操作日志记录
3 具体操作
3.1 登录
浏览器输入http://docs.guthon.com/地址,打开 MinDoc 的 UI 界面。
注册用户名,密码。
登录之后,可以进入后台自定义各种设置,比如网站标题和描述等等
3.2设置按钮
1.
点击操作文档,再点击设置按钮
2.
设置按钮配置
3.3个人中心
进入个人中心页面,修改个人信息、修改密码。
3.4我的项目
添加项目、导入项目。
3.5我的文章
点击添加文章。
3.6操作文档,点击编辑按钮。
3.6.1创建文档
1.
点击+号创建文档。
2.
选中刚刚创建的文档,添加子文档、编辑文档、删除文档。