更新自述文件

This commit is contained in:
yangjian 2020-05-21 20:32:55 +08:00
parent 20a06f03c4
commit 0b532326a2

View File

@ -4,7 +4,7 @@
### 介绍
`MrDoc`是基于`Python`开发的在线文档系统适合作为个人和小型团队的文档、知识和笔记管理工具。致力于成为全平台Web端、桌面端、移动端的私有化在线文档部署方案。
`MrDoc` 是基于`Python`开发的在线文档系统适合作为个人和小型团队的文档、知识和笔记管理工具。致力于成为全平台Web端、桌面端、移动端的私有化在线文档部署方案。
目前涵盖:
@ -16,40 +16,30 @@
### 开源地址
**Gitee:** <https://gitee.com/zmister/MrDoc>
**码云:** <https://gitee.com/zmister/MrDoc>
**GitHub:** <https://github.com/zmister2016/MrDoc>
### 示例站点:
可注册、可创建文集、文档,账号不定期清除,仅作测试用途,请勿编写重要文档。
<http://mrdoc.zmister.com>
<http://mrdoc.zmister.com> 可注册、可创建文集、文档,账号不定期清除,仅作测试用途,请勿编写重要文档。
### 说明文档:
[MrDoc使用文档](http://mrdoc.zmister.com/project-7/)
[文档样式效果和导出样例](http://mrdoc.zmister.com/project-20/)
[MrDoc使用文档](http://mrdoc.zmister.com/project-7/) [文档样式效果和导出样例](http://mrdoc.zmister.com/project-20/)
## 特性:
- **站点与用户系统**
- 支持用户注册、用户登录、用户管理、管理员等基础用户功能;
- 支持注册邀请码配置、广告代码配置、统计代码配置、邮箱找回密码、全站关闭注册等管理功能;
- **站点管理与用户管理**
- 支持用户注册、登录、管理、管理员等基础用户功能;
- 支持站点配置注册邀请码、广告代码、统计代码、邮箱找回密码、全站关闭注册、全站强制登录等管理功能;
- 支持个人中心管理文集、文档、文档模板、图片、附件支持个人中心导出文集MD文件压缩包
- 支持配置文集权限提供公开、私密、指定用户可见、访问码可见4种权限模式
- **文档系统**
- 基于文集进行文档撰写和阅读,拥有**文集**、**文档**、**文档模板**、**图片**和**附件**5大模块
- 使用基于`Editormd``Markdown`编辑器并扩展,以`Markdown`语法进行文档写作:
- 支持**基础Markdown语法**
- 支持**GFM语法**
- 优化**图片上传**,支持粘贴上传、本地文件上传和图片管理插入
- 优化**表格写入**支持编辑HTML表格转为Markdown、Excel内容粘贴为Markdown
- 支持**思维导图**以Markdown的语法创建思维导图
- 支持流程图、时序图的绘制;
- 两栏式**文档阅读**页面、三级目录层级显示,文档阅读字体缩放,字体类型切换,页面社交分享,移动端阅读优化;
- 支持文集**导出打包**,包括`markdown`文本格式`.md`文件、`EPUB`电子书格式文件和PDF格式文件
- 基于文集进行**文档权限**控制提供公开、私密、指定用户可见、访问码可见4种权限模式
- 使用基于`Editormd``Markdown`编辑器优化和扩展,以`Markdown`语法进行文档写作,并支持图片管理和上传、表格粘贴、思维导图绘制、流程图绘制、序列图绘制:
- 两栏式**文档阅读**页面、三级目录层级显示文档阅读字体缩放字体类型切换页面社交分享移动端阅读优化、文集导出PDF、EPUB文件
- 支持基于账户的**`API`接口**,可以借助账户`token`通过`API`获取文集、上传图片和创建文档;
- 支持**文集协作**功能,一个文集可以拥有一个创建者和多个协作者,可灵活选择协作权限;
- 支持**文档历史版本**功能,可以查看和对比历史版本与现有版本的差异,恢复某个历史版本为当前版本;
@ -147,6 +137,8 @@ python manage.py runserver
微信WeChat**taoist_ling**
公众号:**zmister2016**
## 赞赏项目
开源不易需要鼓励如果MrDoc觅道文档对你有所帮助请给予一个`Star`