开源MrDoc，一个适合个人和小型团队的文档、知识、笔记在线管理系统

一、为什么写MrDoc

从2016年底到今天，州的先生在博客上写了一百来篇文章，其中有不少的都是连载类型的系列教程。在积累了一定数量的文章之后，就打算将其整理为一个文集，方便读者朋友的连贯性阅读和学习。但是博客使用的WordPress在进行文集管理方面并不是很好，于是就在市面上找各种文档文集系统。在这个过程中，接触到了很多优秀的文档写作系统：

Gitbook

一个基于Node.js的文档写作工具，可使用 Github/Git 和 Markdown 来制作精美的电子书，其提供本地化地部署，也支持在gitbook上注册账号进行文档写作。

ShowDoc

一个国内团队开发的基于PHP的文档写作系统，可以快速使用Markdown编写文档，更加适用于技术团队的文档写作。目前我在项目中即是使用其作为数据采集数据库的字段说明文档系统。同时也是提供了本地部署的开源版本和线上的使用版本。

WordBook

一个基于WordPress的文档写作主题，文档页面类似于gitbook。据说是免费的，但是下载主题需要加QQ群。

语雀

阿里出品的一款知识库

系统，功能很强大，也有很多人使用。

每个系统都有各自的特点，功能也很丰富，但是在面对自己的需求的使用，也都有一些不如意的地方。兜兜转转还是觉得自己动手写一个比较好。仔细参考和借鉴了一下各个文档系统，发现基本功能的实现并不复杂，那就开干吧。

于是，MrDoc就诞生了。

二、MrDoc都有哪些功能？

MrDoc借鉴了上述部分应用的功能和样式，拥有以下特性：

• 站点与用户系统
  
• 支持用户注册、用户登录、用户管理、管理员等基础用户功能；

• 支持注册邀请码配置、广告代码配置、统计代码配置、邮箱找回密码、全站关闭注册等管理功能；

• 文档系统
  
• 基于文集进行文档撰写和阅读，拥有文集、文档、文档模板、图片和附件5大模块；

• 使用基于Editormd的Markdown编辑器并扩展，以Markdown语法进行文档写作：
• 支持基础Markdown语法
• 支持GFM语法
• 优化图片上传，支持粘贴上传、本地文件上传和图片管理插入
• 优化表格写入，支持编辑HTML表格转为Markdown、Excel内容粘贴为Markdown
• 支持思维导图，以Markdown的语法创建思维导图
• 支持流程图、时序图的绘制；

• 两栏式文档阅读页面、三级目录层级显示，文档阅读字体缩放，字体类型切换，页面社交分享，移动端阅读优化；

• 支持文集后台导出打包markdown文本格式.md文件、前台导出为EPUB等格式文件；
• 基于文集进行文档权限控制，提供公开、私密、指定用户可见、访问码可见4种权限模式；
• 支持基于账户的 API接口 ，可以借助账户token通过API获取文集、上传图片和创建文档；
• 支持文集协作功能，一个文集可以拥有一个创建者和多个协作者，可灵活选择协作权限；
• 支持文档历史版本功能，可以查看和对比历史版本与现有版本的差异，恢复某个历史版本为当前版本；

三、如何下载

MrDoc基于以Python3的Django框架进行编写，前端搭配使用LayUI、JQuery等样式和组件，并完全开源。

目前MrDoc在Gitee和GitHub上均设有代码仓库：

Gitee: https://gitee.com/zmister/MrDoc

GitHub: https://github.com/zmister2016/MrDoc

四、接下来的更新

目前MrDoc已经更新到了0.4.2版本，在后续的版本中，我们会逐渐添加以下功能：

• Chrome浏览器剪藏扩展，快捷地编写文档和收藏笔记；
• 前台文集导出为PDF、DOCX等格式文件；
• Markdown编辑器语法的扩展，让编辑器更加便于使用；
• 用户组和权限的细化；
• ……

如果你有功能需求，欢迎留言提出来，我们将酌情考虑添加。