forked from mirror/MrDoc
修改readme
This commit is contained in:
parent
584832a7f4
commit
e2025e15df
55
README.md
55
README.md
@ -1,45 +1,56 @@
|
||||
# MrDoc
|
||||
|
||||
## 介绍
|
||||
一个简单的文档写作系统
|
||||
一个简单的MarkDown文档写作系统。
|
||||
|
||||
MrDoc拥有以下特点:
|
||||
|
||||
- 基于Django自带的用户模型,实现简单高效的用户管理,支持用户注册、用户登录、管理员等控制等功能;
|
||||
- 基于Editormd的Markdown编辑器,支持Markdown语法的文档写作,支持图片粘贴上传;
|
||||
- 提供文档模板功能,支持文档模板的创建、修改;
|
||||
- 仿GitBook文档阅读页面,支持文档阅读页面的字体缩放,字体类型修改;
|
||||
- 支持三级目录层级显示;
|
||||
- 基于Django传统MTV模式,方便二次开发;
|
||||
|
||||
在开发过程中,借鉴了GitBook、ShowDoc、Wordbook等应用的功能和样式,对此表示感谢。
|
||||
|
||||
## 软件架构
|
||||
基于Python Web框架Django构建。
|
||||
|
||||
语言:Python 3
|
||||
编程语言:Python 3
|
||||
|
||||
后端:Django 2.1
|
||||
后端框架:Django 2.1
|
||||
|
||||
前端UI:LayUI 2.5.4
|
||||
前端UI库:LayUI 2.5.4
|
||||
|
||||
文档编辑器:Editormd
|
||||
MarkDown编辑器:Editormd
|
||||
|
||||
社交分享:Share.js
|
||||
页面社交分享:Share.js
|
||||
|
||||
科学公式:Katex
|
||||
Markdown科学公式:Katex.js
|
||||
|
||||
## 安装教程
|
||||
|
||||
1. 下载并解压;
|
||||
2. 如果需要使用其他数据库,请修改;
|
||||
3. 运行python manage.py makemigrations&&python manage.py migrate 创建和执行数据库迁移;
|
||||
4. 运行python manage.py createsuperuser 创建管理员账号;
|
||||
详见MrDoc使用文档:https://mrdoc.zmister.com
|
||||
|
||||
## 使用说明
|
||||
|
||||
1. xxxx
|
||||
2. xxxx
|
||||
3. xxxx
|
||||
详见MrDoc使用文档:https://mrdoc.zmister.com
|
||||
|
||||
## 二次开发说明
|
||||
|
||||
1. xxxx
|
||||
2. xxxx
|
||||
3. xxxx
|
||||
详见MrDoc使用文档:https://mrdoc.zmister.com
|
||||
|
||||
## 参与贡献
|
||||
## 问题反馈
|
||||
|
||||
1. Fork 本仓库
|
||||
2. 新建 Feat_xxx 分支
|
||||
3. 提交代码
|
||||
4. 新建 Pull Request
|
||||
### 1、提交issue
|
||||
|
||||
直接在https://gitee.com/zmister/MrDoc/issues 页面提交问题。
|
||||
|
||||
### 2、加入MrDoc交流群
|
||||
|
||||
加入MrDoc交流QQ群,群号为735507293,入群密码:mrdoc
|
||||
|
||||
## 版本更新
|
||||
|
||||
关注州的先生微信公众号(ID:zmister2016),及时获取MrDoc版本更新信息。
|
Loading…
Reference in New Issue
Block a user