forked from mirror/MrDoc
app_admin | ||
app_doc | ||
media | ||
MrDoc | ||
static | ||
template | ||
.gitignore | ||
db.sqlite3 | ||
LICENSE | ||
manage.py | ||
MONACO.TTF | ||
README.md | ||
requirements.txt |
MrDoc
介绍
一个简单的MarkDown文档写作系统。
MrDoc拥有以下特点:
- 基于Django自带的用户模型,实现简单高效的用户管理,支持用户注册、用户登录、管理员等控制等功能;
- 基于Editormd的Markdown编辑器,支持Markdown语法的文档写作,支持图片粘贴上传;
- 提供文档模板功能,支持文档模板的创建、修改;
- 仿GitBook文档阅读页面,支持文档阅读页面的字体缩放,字体类型修改;
- 支持三级目录层级显示;
在开发过程中,参考和借鉴了GitBook、ShowDoc、Wordbook等应用的功能和样式。
软件架构
基于Python Web框架Django构建。
编程语言:Python 3
后端框架:Django 2.1
前端UI库:LayUI 2.5.4
MarkDown编辑器:Editormd
页面社交分享:Share.js
Markdown科学公式:Katex.js
安装教程
详见MrDoc使用文档:http://mrdoc.zmister.com
使用说明
详见MrDoc使用文档:http://mrdoc.zmister.com
二次开发说明
详见MrDoc使用文档:http://mrdoc.zmister.com
问题提交和反馈
1、提交issue
直接在https://gitee.com/zmister/MrDoc/issues 页面提交问题。
2、加入MrDoc交流群
加入MrDoc交流QQ群,群号为735507293,入群密码:mrdoc
版本更新
关注州的先生微信公众号(ID:zmister2016),及时获取MrDoc版本更新信息。