题外话

有没有过想看某个项目资料或者接口或者文档资料等怎么都找不到的精力，或者有一堆文档，但是不知道自己想要找的内容在哪个文档里？恭喜你不要999，也不要99 ，只要0.0元 在线文档送到家 ( ^_^ ) 

本节本身和mini cloud 框架本身关系不大，但是和每个人都有着紧密联系，毕竟每个人的开发都离不开框架文档，接口文档，详设文档等，这节主要是给大家分享一个轻量级适合中小团队和公司得在线文档系统 mrDoc 

---

 

---

 进入正题

什么才算是在线文档系统，为什么要使用在线文档 

 

首先我们来聊一下为什么开发环境需要一个在线文档系统，聊之前首先我们得确认一下什么是在线文档系统，是不是一个地址文档可以下载就算在线文档系统了呢，我个人觉得，算也不算，这个得看具体使用场景，如果说文档明细已经做的很好了，有一个文档明确记录了哪个文档得下载地址以及划分明确，并且变动不大的情况下，其实是可以满足一般需求得，但是如果文档是一个生命周期的过程中而不是结束了归档了，那么其实是不符合在线文档系统需求的，我觉得一般需要具备以下特点：

### 1.可以在线编辑，预览，最好可以支持word 格式上传
### 2.可以进行版本管理与对比
### 3.可以进行权限控制，也就是哪些角色可以对这个文档做什么事
### 4.可以对文档进行父子关系或者关联关系管理
### 5.可以全文检索

 

我觉得具备了以上特点的才可称之为在线文档系统，我们很多开发环境用git或者svn进行文档管理，它具备了共享，在线预览权限管理等特点，但是对都是基于目录层级或者项目级别的，不具备父子关联关系管理，所以我觉得不算是在线文档系统

目前比较常用的在线文档

### 说了这么多，那市面上比较常用的一些在线文档是哪些呢
### gitbook: 其实github,gitlab本身就自持自家系列的文档系统gitbook，而且功能强大，和git无缝对接，但是我觉得就是因为追求通用以及功能强大
### 导致了过于重，如果是大型团队或者公司我比较推荐这个
### wiki：是国内外比较通用的文档系统，但是一样操作繁琐复杂度高，我觉得如果中小公司或者团队可以选择我推荐的mrDoc
### lanhu:蓝狐一般是针对前端的，但是其实可以作为在线文档系统去使用，但是无法私有部署
### 语雀：和蓝狐一样，都挺好就是无法私有化部署
### mrDoc：今天主要我推荐的就是这个，很轻量，但是该有的功能都有，操作符合国人习惯

 

 mrDoc 优缺点

### 优点：可以在线预览编辑，也支持多格式编辑，还有支持导入导出功能，可以全文检索，也具备权限管理功能，还有桌面客户端，还可以进行独立得素材管理，最重要的是很轻量，部署也方便
### 缺点：由于刚刚起部，权限管理以及下载格式支持的还够完善

 

 

mrDoc docker部署开源版

 

一、拉取 MrDoc 代码
进入目录：

cd /opt
开源版：
git clone https://gitee.com/zmister/MrDoc.git

二、获取 Docker 镜像

方式一：拉取镜像
docker pull zmister/mrdoc:v4
 
三、运行 Docker 容器
开源版：
docker run -d --name mrdoc -p 10086:10086 -v /opt/MrDoc:/app/MrDoc zmister/mrdoc:v4
 
四、管理
创建管理员账户
docker exec -it mrdoc python manage.py createsuperuser
修改用户密码
docker exec -it mrdoc python manage.py changepassword 用户名
停止容器
docker stop mrdoc
启动容器
docker start mrdoc
删除容器
docker rm -f mrdoc

 

 部署后访问服务器ip +端口号10086，首页如下

 

 

mrDoc 使用 ，以下列举几个常用功能

创建文集：如果按照项目管理的话，一般就是一个项目创建一个文集，如图是我们项目即将启动之前我对项目创建了一个文集，然后放上去一些共通文档和开发文档，因为需求还在调研，所以还没放需求文档和逻辑文档

 

 

创建文档：文档隶属于某个文集，也可以设置其他文档为自己的父类，最终形成树形结构

 

 

个人中心：在里面可以管理自己的文档以及一些属性

 

 

 

 后台管理：如果是超级管理员，则可以进行其他文档的管理，也可以进行用户管理等

 

 

 

 

 

总结：如果是中小行公司或者团队，推荐使用mrDoc,确实好用~