{"id":13455874,"url":"https://github.com/zmister2016/MrDoc","last_synced_at":"2025-03-24T09:30:57.927Z","repository":{"id":37727081,"uuid":"254536602","full_name":"zmister2016/MrDoc","owner":"zmister2016","description":"mrdoc,online document system developed based on python. It is suitable for individuals and small teams to manage documents, wiki, knowledge and notes. 觅思文档，适合于个人和中小型团队的在线文档、知识库系统。","archived":false,"fork":false,"pushed_at":"2025-03-14T05:24:50.000Z","size":40251,"stargazers_count":3054,"open_issues_count":47,"forks_count":565,"subscribers_count":48,"default_branch":"master","last_synced_at":"2025-03-20T02:59:38.694Z","etag":null,"topics":["django","document-management","knowledge-management","markdown","notes-app","python","wiki"],"latest_commit_sha":null,"homepage":"https://mrdoc.pro/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zmister2016.png","metadata":{"files":{"readme":"README-zh.md","changelog":"CHANGES.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":null,"patreon":null,"open_collective":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null}},"created_at":"2020-04-10T03:37:11.000Z","updated_at":"2025-03-19T06:05:37.000Z","dependencies_parsed_at":"2023-09-24T03:34:05.131Z","dependency_job_id":"2c179e7b-3052-456d-9f2a-00034cc387e0","html_url":"https://github.com/zmister2016/MrDoc","commit_stats":{"total_commits":814,"total_committers":19,"mean_commits":42.8421052631579,"dds":"0.10073710073710074","last_synced_commit":"14a54a6f968fce2771d5efd2f38cc4b95455e5f1"},"previous_names":[],"tags_count":44,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zmister2016%2FMrDoc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zmister2016%2FMrDoc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zmister2016%2FMrDoc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zmister2016%2FMrDoc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zmister2016","download_url":"https://codeload.github.com/zmister2016/MrDoc/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245243173,"owners_count":20583576,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["django","document-management","knowledge-management","markdown","notes-app","python","wiki"],"created_at":"2024-07-31T08:01:12.669Z","updated_at":"2025-03-24T09:30:57.913Z","avatar_url":"https://github.com/zmister2016.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","语言资源库","Wiki-Server","JavaScript (485)","General Tools"],"sub_categories":["JavaScript","Knowledge Base"],"readme":"\u003ch1 align=\"center\"\u003e觅思文档开源版\u003c/h1\u003e\n\n\u003cp align=\"center\"\u003e个人和小型团队的云笔记、云文档、知识管理私有化部署方案\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n\u003ca href=\"./README-zh.md\"\u003e中文介绍\u003c/a\u003e |\n\u003ca href=\"./README.md\"\u003eEnglish Description\u003c/a\u003e \n\u003c/p\u003e\n\n\n\u003cp align=\"center\"\u003e\n\u003cimg src=\"https://img.shields.io/badge/MrDoc-v0.9.5-brightgreen.svg\" title=\"Mrdoc\" /\u003e\n\u003cimg src=\"https://img.shields.io/badge/Python-3.9+-blue.svg\" title=\"Python\" /\u003e\n\u003cimg src=\"https://img.shields.io/badge/Django-v4.2-important.svg\" title=\"Django\" /\u003e\n\u003ca href=\"https://hellogithub.com/repository/6494f041e00d4b8481ed1114a0bd33c1\" target=\"_blank\"\u003e\u003cimg src=\"https://api.hellogithub.com/v1/widgets/recommend.svg?rid=6494f041e00d4b8481ed1114a0bd33c1\u0026claim_uid=3IU9mFeOVT0cXyw\u0026theme=small\" alt=\"Featured｜HelloGitHub\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://mrdoc.pro\"\u003e官网\u003c/a\u003e | \n\u003ca href=\"http://mrdoc.zmister.com/\"\u003e演示站点\u003c/a\u003e |\n\u003ca href=\"https://www.bilibili.com/video/BV1LF411u7NM/\"\u003e零基础视频教程\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://doc.mrdoc.pro/p/deploy/\"\u003e安装手册\u003c/a\u003e | \n\u003ca href=\"https://doc.mrdoc.pro/p/user-guide/\"\u003e使用手册\u003c/a\u003e |\n\u003ca href=\"https://doc.mrdoc.pro/p/example/\"\u003e文档效果\u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e源码：\u003ca href=\"https://gitee.com/zmister/MrDoc\"\u003e码云\u003c/a\u003e | \n\u003ca href=\"https://github.com/zmister2016/MrDoc\"\u003eGitHub\u003c/a\u003e\n\u003c/p\u003e\n\n## 简介\n\n`MrDoc` 是基于`Python`开发的在线文档系统。\n\nMrDoc 适合作为个人和中小型团队的私有云文档、云笔记和知识管理工具，致力于成为优秀的私有化在线文档部署方案。\n\n你可以简单粗暴地将 MrDoc 视为「可私有部署的语雀」和「可在线编辑文档的GitBook」。\n\nMrDoc 全系产品目前涵盖以下终端：\n\n- 🌐Web端：开源版、专业版，[版本对比](https://doc.mrdoc.pro/doc/3441/)\n- 💻浏览器扩展：支持 Chromium 系列浏览器、Firefox 浏览器，[下载地址](https://gitee.com/zmister/mrdoc-webclipper)\n- 🗔桌面客户端：支持 Windows、macOS、Linux，[下载地址](https://gitee.com/zmister/mrdoc-desktop-release/releases/)\n- 📱移动客户端：支持 Android，[下载地址](https://gitee.com/zmister/mrdoc-app-release)\n- Obsidian 同步插件：[使用教程](https://doc.mrdoc.pro/doc/45650/)\n\n## 演示站点\n\n开源版 - [http://mrdoc.zmister.com](http://mrdoc.zmister.com)\n\n专业版 - [https://doc.mrdoc.pro](https://doc.mrdoc.pro)\n\n开源版与专业版对比 - [https://doc.mrdoc.pro/doc/3441/](https://doc.mrdoc.pro/doc/3441/)\n\n用户名：test1  密码：123456\n\n## 适用场景\n\n个人云笔记、在线产品手册、团队内部知识库、在线电子教程等私有化部署场景。\n\n## 功能特性\n\n- **⚙站点管理**\n\t- 用户管理\n\t- 图片管理\n\t- 附件管理\n\t- 文档管理\n\t- 文集管理\n\t- 注册邀请码配置\n\t- 登录验证码配置\n\t- 全站禁止注册配置\n\t- 全站强制登录配置\n\t- 广告代码配置\n\t- 统计代码配置\n\t- 站点信息配置\n\t- 备案号配置\n\t- 附件配置\n\n- **🧑个人管理**\n\t- 文集管理\n\t- 文档管理：新建、删除、回收站、历史版本\n\t- 文档模板管理：新建、删除\n\t- 图片管理：上传、分组、删除\n\t- 附件管理：上传、删除\n\t- Token管理：借助Token API 接口高效新建和获取文档；\n\t- 个人信息管理：修改昵称、修改电子邮箱、切换文档编辑器；\n\n- **📚文集控制**\n    - 文集图标配置\n    - 文字水印配置\n    - 文集权限配置：公开、私密、指定用户可见、访问码可见\n    - 下载配置：PDF、EPUB文件生成和下载\n    - 文集协作成员配置\n    - 文集文档拖拽排序\n    - 文集导出\n    - 文集转让\n    \n- **✍文档书写**\n\t- 文本文档、表格文档两种文档类型，`Markdown` 、富文本两种编辑模式，`Editor.md`、`Vditor`、`iceEditor`三种编辑器加持，自由选择、自由切换；\n\t- 图片、附件、科学公式、音视频、思维导图、流程图、Echart图表；\n\t- 文档排序、文档上级设置、文档模板插入；\n\t- 文档标签设置；\n\n- **📖文档阅读**\n\t- 两栏式布局，三级目录层级显示，左侧文集大纲，右侧文档正文；\n\t- 文档阅读字体缩放、字体类型切换、日间夜间模式切换、页面社交分享、移动端阅读优化；\n\t- 文档 Markdown 文件下载；\n\t- 标签关系网络图；\n\t- 文档全文搜索；\n\t- 文档分享码分享；\n\t- 文档收藏；\n\t\n- **其他特性**\n    - 搜索引擎收录支持；\n    - sitemap站点地图；\n    - 无限用户限制；\n    - 无限空间限制；\n\n完整更新记录详见：[CHANGES.md](./CHANGES.md)\n\n## 简明运行教程\n\n### 1、安装依赖库\n```\npip install -r requirements.txt\n```\n\n### 2、初始化数据库\n\n在安装完所需的第三方库并配置好数据库信息之后，我们需要对数据库进行初始化。\n\n在项目路径下打开命令行界面，运行如下命令生成数据库迁移：\n\n```\npython manage.py makemigrations \n```\n\n运行如下命令执行数据库迁移:\n\n```\npython manage.py migrate\n```\n执行完毕之后，数据库就初始化完成了。\n\n### 3、创建管理员账户\n在初始化完数据库之后，需要创建一个管理员账户来管理整个MrDoc，在项目路径下打开命令行终端，运行如下命令：\n```\npython manage.py createsuperuser\n```\n按照提示输入用户名、电子邮箱地址和密码即可。\n\n### 4、测试运行\n在完成上述步骤之后，即可运行使用MrDoc。\n\n在测试环境中，可以使用Django自带的服务器运行MrDoc，其命令为：\n\n```\npython manage.py runserver\n```\n\n## 部署工具\n\n- [Docker 官方镜像](https://hub.docker.com/r/zmister/mrdoc)\n- [Docker镜像 By jonnyan404 ](https://registry.hub.docker.com/r/jonnyan404/mrdoc-nginx)\n- [Linux 一键部署脚本 By jonnyan404](https://gitee.com/jonnyan404/oh-my-mrdoc)\n- [Windows 部署面板 By 小肥羊](https://gitee.com/debj031634/win-django)\n- [VirtualBox/VmWare 虚拟机镜像 By 无名](https://gitee.com/nicktf/tinycore-mrdoc)\n\n## 文档导入工具\n\n- [觅思文档导入工具箱](https://gitee.com/zmister/mrdoc-import-toolbox)\n    - 觅思文档导出的文集\n    - 语雀知识库\n    - 印象笔记\n    - Joplin\n\n## 其他工具\n\n- [本地文档同步工具 By Atyin](https://gitee.com/atyin/mrdocTools)\n\n## 交流\n\n\u003cp align=\"center\"\u003e\n\u003cimg src=\"https://doc.mrdoc.pro/media/202203/20220331121926_20220331122015390193.png\" width=\"50%\"\u003e\n\u003c/p\u003e\n\n## 依赖\n\n觅思文档基于以下开源项目进行开发，在此表示感谢：\n\n- Python\n- Django\n- Jquery\n- LayUI\n- PearAdminLayui\n- Editor.md\n- Marked\n- CodeMirror\n- Echarts\n- Viewer.js\n- Sortable.js\n- Vditor\n- iceEditor\n\n## 协议\n\n\u003ca href=\"./LICENSE\"\u003eGPL-3.0\u003c/a\u003e\n\n开源版的使用者必须保留 MrDoc 和觅思文档相关版权标识，禁止对 MrDoc 和 觅思文档相关版权标识进行修改和删除。\n\n如果违反，开发者保留对侵权者追究责任的权利。\n\n其他相关协议亦可参考《[免责声明](https://gitee.com/zmister/MrDoc/blob/master/DISCLAIMER.md)》。\n\n商业授权（专业版）请微信咨询：\n\n\u003cimg src=\"https://doc.mrdoc.pro/media/202212/wechatwork_qrcode_20221201165203490192.png\" width=\"200px\" /\u003e","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzmister2016%2FMrDoc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzmister2016%2FMrDoc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzmister2016%2FMrDoc/lists"}