觅思文档开源版

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

## 简介 `MrDoc` 是基于`Python`开发的在线文档系统。 MrDoc 适合作为个人和中小型团队的私有云文档、云笔记和知识管理工具，致力于成为优秀的私有化在线文档部署方案。你可以简单粗暴地将 MrDoc 视为「可私有部署的语雀」和「可在线编辑文档的GitBook」。 MrDoc 全系产品目前涵盖以下终端： - Web端：开源版、专业版，[版本差异](https://doc.mrdoc.pro/project-7/doc-3441/) - Chrome 浏览器扩展：[Gitee](https://gitee.com/zmister/mrdoc-webclipper) | [MicroSoft Edge 应用商店](https://microsoftedge.microsoft.com/addons/detail/dihimgafbjljdfanobikhnolpmjjhpic) | [Chrome](https://chrome.google.com/webstore/detail/jefmnpfkhhmmnfbhaegnggffbdplijje) - 桌面客户端：支持 Windows、macOS、Linux，[下载链接](https://gitee.com/zmister/mrdoc-desktop-release/releases/) - 移动客户端APP：支持 Android，[下载链接](https://gitee.com/zmister/mrdoc-app-release) - 微信小程序（开发中） ## 演示站点开源版 - [http://mrdoc.zmister.com](http://mrdoc.zmister.com) 专业版 - [https://doc.mrdoc.pro](https://doc.mrdoc.pro) 开源版与专业版差异 - [https://doc.mrdoc.pro/project-7/doc-3441/](https://doc.mrdoc.pro/project-7/doc-3441/) 用户名：test1 密码：123456 ## 打赏支持

「付费部署服务」请添加作者QQ：3280350050

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

微信| 支付宝| 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 ``` ## 部署工具 - [Docker 官方镜像](https://hub.docker.com/r/zmister/mrdoc) - [Docker镜像 By jonnyan404 ](https://registry.hub.docker.com/r/jonnyan404/mrdoc-nginx) - [Linux 一键部署脚本 By jonnyan404](https://gitee.com/jonnyan404/oh-my-mrdoc) - [Windows 部署面板 By 小肥羊](https://gitee.com/debj031634/win-django) - [VirtualBox/VmWare 虚拟机镜像 By 无名](https://gitee.com/nicktf/tinycore-mrdoc) ## 交流

QQ群：735507293

## 依赖觅思文档基于以下开源项目进行开发，在此表示感谢： - Python - Django - Jquery - LayUI - PearAdminLayui - Editor.md - Marked - CodeMirror - Echarts - Viewer.js - Sortable.js - Vditor - TinyMCE ## 协议 GPL-3.0 开源版的使用者必须保留 MrDoc 和觅思文档相关版权标识，禁止对 MrDoc 和觅思文档相关版权标识进行修改和删除。如果违反，开发者保留对侵权者追究责任的权利。商业授权（专业版）请联系QQ咨询：3280350050