一、开源项目简介

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

基于Python开发的在线文档系统，适合作为个人和小型团队的私有云文档、云笔记和知识管理工具。致力于成为优秀的私有化在线文档部署方案。

二、功能概述

文档系统目前支持以 Markdown 和富文本两种方式进行文档编写，同时存在 Editor.md、Vditor 和 iceEditor 三种编辑器供用户进行使用。

在两个 Markdown 编辑器中，Editor.md 编辑器在基于原始 Editor.md 项目的基础上进行自行维护和扩展，在功能上会不断进行优化和更新；而 Vditor 则会尽力保持与官方版本的同步。

这两个编辑器虽然同为 Markdown 编辑器，但在语法上有细微的差异。

而对于富文本编辑器 iceEditor 也会在保持文档系统项目一致性的基础上，保持与官方版本的同步。

目前涵盖终端：

• Web端
• Chrome扩展：
• MrDoc官方插件：使用说明；
• 简悦扩展：使用说明

开发中的终端：

• 手机APP

计划中的终端：

• 桌面客户端

适用场景

个人云笔记、在线产品手册、团队内部知识库、在线电子教程等私有化部署场景。

功能特性

站点管理

• 用户注册、用户登录、用户管理、图片管理、附件管理、文档管理、文集管理、注册邀请码配置、全站关闭注册开关、全站强制登录开关；
• 广告代码配置、统计代码配置、站点信息配置、备案号配置；
• 附件格式配置、附件大小配置、图片大小配置；

个人管理

• 文集管理：新建、删除、权限控制、转让、协作、导出、生成电子书格式文件
• 文档管理：新建、删除、回收站、历史版本
• 文档模板管理：新建、删除
• 图片管理：上传、分组、删除
• 附件管理：上传、删除
• Token管理：借助Token高效新建和获取文档；
• 个人信息管理：修改昵称、修改电子邮箱、切换文档编辑器；

文档书写

• 文本文档、表格文档两种文档类型，Markdown 、富文本两种编辑模式，Editor.md、Vditor、iceEditor三种编辑器加持，自由选择、自由切换；
• 图片、附件、科学公式、音视频、思维导图、流程图、Echart图表；
• 文档排序、文档上级设置、文档模板插入；
• 文档标签设置；

文档阅读

• 两栏式布局，三级目录层级显示，左侧文集大纲，右侧文档正文；
• 文档阅读字体缩放、字体类型切换、页面社交分享、移动端阅读优化；
• 文集EPUB、PDF文件下载，文档Markdown文件下载；
• 标签关系网络图；
• 文档全文搜索；
• 私密文档分享码分享

三、技术选型

基于 Python3 语言的 Django 框架编写而成，在安装之前，请确保目标计算机上安装有 Python3 编程语言。

在 Linux 平台中，部分操作中的pip、python等命令，可能需要替换为pip3和python3

零、依赖环境

操作系统：

• Windows
• Linux
• macOS

编程语言：

• Python 3.5+

文档系统使用了以下技术栈：

• 后端：Python + Django
• 前端：LayUI + JQuery

所以，其安装和部署与常规的Python Web应用（Django 应用）无异。本文集将会介绍文档系统在各个操作系统和环境下的部署，包括但不限于：

• Linux
• Windows
• Docker
• 宝塔面板

依赖

文档系统基于以下项目进行开发，在此表示感谢：

• Python
• Django
• Jquery
• LayUI
• PearAdminLayui
• Editor.md
• Marked
• CodeMirror
• Echarts
• Viewer.js
• Sortable.js
• Vditor
• TinyMCE

四、界面展示

五、开源协议

使用GPL-3.0开源协议

开源版的使用者必须保留文档系统相关版权标识，禁止对文档系统相关版权标识进行修改和删除。

如果违反，开发者保留对侵权者追究责任的权利。

六、源码地址

私信回复：知识库