MrDoc觅道文档 - 记录文档、汇聚思想

个人和小型团队的笔记、文档、知识管理私有化部署方案

## 简介 `MrDoc` 是基于`Python`开发的在线文档系统，适合作为个人和小型团队的文档、知识和笔记管理工具。致力于成为优秀的私有化在线文档部署方案。目前涵盖： - Web端，[安装手册](http://mrdoc.zmister.com/project-7/)，[使用手册](http://mrdoc.zmister.com/project-54/)； - Chrome扩展： - [MrDoc官方插件](https://gitee.com/zmister/mrdoc-webclipper)：[使用说明](http://mrdoc.zmister.com/project-7/doc-243/)； - [简悦扩展](https://github.com/Kenshin/simpread)：[使用说明](https://github.com/Kenshin/simpread/issues/893) - App端（开发中） ## 打赏

给作者打赏一罐红牛，祝他天天能迭代，日日可更新。打赏赞助鸣谢榜

微信| 支付宝| QQ| PayPal | Ko-Fi

## 功能特性 - **站点管理** - 用户注册、用户登录、用户管理、注册邀请码配置、全站关闭注册开关、全站强制登录开关； - 广告代码配置、统计代码配置、站点信息配置、备案号配置； - 附件格式配置、附件大小配置、图片大小配置； - **个人管理** - 文集管理：新建、删除、权限控制、转让、协作、导出、生成电子书格式文件 - 文档管理：新建、删除、回收站、历史版本 - 文档模板管理：新建、删除 - 图片管理：上传、分组、删除 - 附件管理：上传、删除 - Token管理：借助Token高效新建和获取文档； - 个人信息管理：修改昵称、修改电子邮箱、切换文档编辑器； - **文档书写** - `Markdown` 、富文本两种编辑模式，`Editor.md`、`Vditor`、`iceEditor`三种编辑器加持，自由选择、自由切换； - 图片、附件、科学公式、音视频、思维导图、流程图、Echart图表； - 文档排序、文档上级设置、文档模板插入； - 标签设置； - **文档阅读** - 两栏式布局，三级目录层级显示，左侧文集大纲，右侧文档正文； - 文档阅读字体缩放、字体类型切换、页面社交分享、移动端阅读优化； - 文集EPUB、PDF文件下载，文档Markdown文件下载； - 标签关系网络图； - 文档全文搜索；完整更新记录详见：[CHANGES.md](./CHANGES.md) ## 简明安装教程 ### 1、安装依赖库 ``` pip install -r requirements.txt ``` ### 2、初始化数据库在安装完所需的第三方库并配置好数据库信息之后，我们需要对数据库进行初始化。在项目路径下打开命令行界面，运行如下命令生成数据库迁移： ``` python manage.py makemigrations ``` 运行如下命令执行数据库迁移: ``` python manage.py migrate ``` 执行完毕之后，数据库就初始化完成了。 ### 3、创建管理员账户在初始化完数据库之后，需要创建一个管理员账户来管理整个MrDoc，在项目路径下打开命令行终端，运行如下命令： ``` python manage.py createsuperuser ``` 按照提示输入用户名、电子邮箱地址和密码即可。 ### 4、测试运行在完成上述步骤之后，即可运行使用MrDoc。在测试环境中，可以使用Django自带的服务器运行MrDoc，其命令为： ``` python manage.py runserver ``` ## 交流

微信公众号：州的先生（ID：zmister2016）

QQ群：735507293

## 依赖觅道文档基于以下项目进行开发，在此表示感谢： - Python - Django - Jquery - LayUI - PearAdminLayui - Editor.md - Marked - CodeMirror - Echarts - Viewer.js - Sortable.js - Vditor - iceEditor ## 协议 GPL-3.0