1
0
forked from mirror/MrDoc
MrDoc/README.md

154 lines
5.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# MrDoc - 记录文档,汇聚思想,一个简单的文档记录和管理应用
**PC端文档阅读界面**
![Mrdoc首页](./docs/mrdoc_2019080101.gif)
## 介绍
州的先生 - https://zmister.com - 自用并完全开源、基于Python编写的文档写作系统。
使用MarkDown快速记录你所思所想仿GitBook两栏式阅读界面清晰高效浏览。
当前版本为:**v0.3.3**,版本发布时间为**2020-03-21**,此版本主要更新了如下内容:
- 修复后台管理无法删除文档的错误;
- 修复后台新建无法新建文集的错误;
- 优化图片上传逻辑新增后台图片管理功能前端编辑器替换Editor.md自带的图片上传组件支持上传图片和从已有图片中选择图片
- 优化首页无文集时的样式,添加默认显示的图片;
- 优化首页文集无文档时,显示默认提示文字;
- 优化404页面更换统一风格的404图片
- 调整文档阅读页面目录使用悬浮弹出框显示;
- 增强安全性,替换前端请求字符串值中的特殊符号;
完整更新记录详见:[CHANGES.md](./CHANGES.md)
MrDoc拥有以下特点
- 站点与用户系统简洁
- 基于Django自带的用户模型实现简单高效的用户管理支持用户注册、用户登录、管理员等控制等功能
- 支持全站关闭注册;
- 支持注册邀请码配置;
- 支持广告位自定义配置;
- 支持统计代码自定义配置;
- 文档系统清晰
- 基于文集的文档撰写和阅读;
- 基于Editormd的Markdown编辑器支持Markdown语法的文档写作支持图片粘贴上传支持从本地MD文件中插入内容
- 提供文档模板功能,支持文档模板的创建、修改;
- 仿GitBook文档阅读页面支持文档阅读页面的字体缩放字体类型修改页面社交分享良好的移动端阅读体验
- 支持三级目录层级显示;
- 支持文集后台导出为markdown文本格式.md文件、前台导出为EPUB电子书
- 基于文集进行权限控制提供公开、私密、指定用户可见、访问码可见4种权限模式
在开发过程中参考和借鉴了GitBook、ShowDoc、Wordbook等应用和网站的功能与样式并使用了众多开源组件、插件。
## 应用核心依赖环境
- 编程语言Python 3+
- Django框架2.0+
## 安装教程
### 1、安装依赖库
```
pip install -r requirements.txt
```
### 2、配置数据库信息
默认情况下MrDoc使用Django的SQLite数据库在旧版本MrDoc附带了一个Sqlit数据库如果你使用的是MrDoc源码附带的Sqlite数据库或使用Sqlite数据库则无需另外配置数据库。
如果有配置其他数据库的需求,请在/MrDoc/MrDoc目录下打开settings.py文件在约80行的位置将如下代码
```
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.sqlite3',
'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
}
}
```
按照自己数据库的信息将其修改如下格式下面以MySQL为例
```
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.mysql', # 使用的数据库后端
'NAME': 'mrdoc', # 数据库名
'USER':'root', # 数据库用户
'PASSWORD':'123456789', # 数据库用户密码
'HOST':'', # 数据库主机地址
'PORT':'3306', # 数据库端口
}
}
```
### 3、初始化数据库
在安装完所需的第三方库并配置好数据库信息之后,我们需要对数据库进行初始化。
在项目路径下打开命令行界面,运行如下命令生成数据库迁移:
```
python manage.py makemigrations
```
接着,运行如下命令执行数据库迁移:
```
python manage.py migrate
```
执行完毕之后,数据库就初始化完成了。
### 4、创建管理员账户
在初始化完数据库之后需要创建一个管理员账户来管理整个MrDoc在项目路径下打开命令行终端运行如下命令
```
python manage.py createsuperuser
```
按照提示输入用户名、电子邮箱地址和密码即可。
### 5、测试运行
在完成上述步骤之后即可运行使用MrDoc。
在测试环境中可以使用Django自带的服务器运行MrDoc其命令为
```
python manage.py runserver
```
## 使用说明
详见MrDoc使用文档:http://mrdoc.zmister.com
## 二次开发说明
详见MrDoc使用文档:http://mrdoc.zmister.com
## 问题提交和反馈
### 1、提交issue
直接在https://gitee.com/zmister/MrDoc/issues 页面提交问题。
### 2、加入MrDoc交流群
加入MrDoc交流QQ群群号为735507293入群密码mrdoc
## 版本更新
关注州的先生微信公众号IDzmister2016、博客 https://zmister.com 及时获取MrDoc版本更新信息。
## 更多截图
### 文档界面
![MrDoc文档页](./docs/mrdoc_docdetail.png)
### 登录界面
![MrDoc登录页](./docs/mrdoc_login.png)
### 注册界面
![MrDoc注册页](./docs/mrdoc_register.png)
### 文档写作界面
![MrDoc写作页](./docs/mrdoc_write.png)
### 文档模板界面
![MrDoc文档模板页](./docs/mrdoc_doctemp.png)
### 管理员后台界面
![MrDoc管理员后台](./docs/mrdoc_admin.png)
### 普通用户后台界面
![MrDoc普通用户后台](./docs/mrdoc_user.png)