5.8 KiB
MrDoc觅道文档 - 记录文档，汇聚思想
介绍
MrDoc是基于Python开发的在线文档系统，适合作为个人和小型团队的文档、知识和笔记管理工具。致力于成为全平台（Web端、桌面端、移动端）的私有化在线文档部署方案。
目前涵盖：
开源地址
Gitee: https://gitee.com/zmister/MrDoc
GitHub: https://github.com/zmister2016/MrDoc
示例站点：
可注册、可创建文集、文档，账号不定期清除，仅作测试用途，请勿编写重要文档。
说明文档：
特性：
-
站点与用户系统
- 支持用户注册、用户登录、用户管理、管理员等基础用户功能；
- 支持注册邀请码配置、广告代码配置、统计代码配置、邮箱找回密码、全站关闭注册等管理功能；
-
文档系统
- 基于文集进行文档撰写和阅读，拥有文集、文档、文档模板、图片和附件5大模块；
- 使用基于
Editormd的Markdown编辑器并扩展，以Markdown语法进行文档写作：- 支持基础Markdown语法
- 支持GFM语法
- 优化图片上传，支持粘贴上传、本地文件上传和图片管理插入
- 优化表格写入，支持编辑HTML表格转为Markdown、Excel内容粘贴为Markdown
- 支持思维导图，以Markdown的语法创建思维导图
- 支持流程图、时序图的绘制；
- 两栏式文档阅读页面、三级目录层级显示，文档阅读字体缩放，字体类型切换，页面社交分享，移动端阅读优化；
- 支持文集导出打包，包括
markdown文本格式.md文件、EPUB电子书格式文件和PDF格式文件； - 基于文集进行文档权限控制，提供公开、私密、指定用户可见、访问码可见4种权限模式；
- 支持基于账户的**
API接口**，可以借助账户token通过API获取文集、上传图片和创建文档； - 支持文集协作功能，一个文集可以拥有一个创建者和多个协作者，可灵活选择协作权限；
- 支持文档历史版本功能，可以查看和对比历史版本与现有版本的差异，恢复某个历史版本为当前版本；
当前版本为：v0.5.2beta
完整更新记录详见：CHANGES.md
在开发过程中，参考和借鉴了GitBook、ShowDoc、Wordbook等应用和网站的功能与样式，并使用了众多开源组件、插件。
应用核心依赖环境
MrDoc基于Python语言的Django Web框架配合前端的LayUI、JQuery等库进行开发。
MrDoc在Python 3.6 + Django 2.2上进行开发，并且在Django 2.1、2.2和Python3.5、3.6、3.7上测试运行良好，在其他环境下运行MrDoc不排除有未知的异常。。
简明安装教程
1、安装依赖库
pip install -r requirements.txt
2、配置数据库信息
默认情况下，MrDoc使用Django的SQLite数据库，如果你使用Sqlite数据库，则无需另外配置数据库。
如果有配置其他数据库的需求，请首先按照Django官方的数据库支持说明，安装特定数据库的Python绑定库，
然后在/MrDoc/config目录下打开conig.ini文件，根据自己的数据库信息进行修改：
# engine，指定数据库类型，接受sqlite、mysql、oracle、postgresql
engine = sqlite
# name表示数据库的名称
# name = db_name
# user表示数据库用户名
# user = db_user
# password表示数据库用户密码
# password = db_pwd
# host表示数据库主机地址
# host = db_host
# port表示数据库端口
# port = db_port
按照自己数据库的信息，将其修改如下格式，下面以MySQL为例：
3、初始化数据库
在安装完所需的第三方库并配置好数据库信息之后，我们需要对数据库进行初始化。
在项目路径下打开命令行界面，运行如下命令生成数据库迁移：
python manage.py makemigrations
运行如下命令执行数据库迁移:
python manage.py migrate
执行完毕之后，数据库就初始化完成了。
4、创建管理员账户
在初始化完数据库之后，需要创建一个管理员账户来管理整个MrDoc，在项目路径下打开命令行终端，运行如下命令：
python manage.py createsuperuser
按照提示输入用户名、电子邮箱地址和密码即可。
5、测试运行
在完成上述步骤之后，即可运行使用MrDoc。
在测试环境中，可以使用Django自带的服务器运行MrDoc，其命令为：
python manage.py runserver
问题提交和反馈
1、提交issue
在如下页面提交问题：
2、加入MrDoc交流群
加入MrDoc交流QQ群，群号为735507293，入群密码：mrdoc
3、联系作者
微信（WeChat）：taoist_ling
赞赏项目
开源不易，需要鼓励，如果MrDoc觅道文档对你有所帮助，请给予一个Star。
欢迎给予开发者赞赏，助力项目更好发展。
