diff --git a/README-en.md b/README-en.md new file mode 100644 index 0000000..b3f9f3b --- /dev/null +++ b/README-en.md @@ -0,0 +1,180 @@ +

MrDoc - Writing documents, Gathering ideas

+ +

Personal and small team notes, documents, knowledge management privatization deployment scheme

+ +

+中文介绍 | +English Description +

+ +

+ + + +

+ +

+Home | +Example Site | +QQ Group + +

+ +

+Installation Manual | +User Manual | +Document Example +

+ + +

Source code:Gitee | +GitHub +

+ + +### Introduce + +`Mrdoc` is an online document system developed based on python. It is suitable for individuals and small teams to manage documents, knowledge and notes. It is committed to become a private online document deployment solution for the whole platform (web, desktop, mobile). + +Current Platform: + +- Web,[instructions](http://mrdoc.zmister.com/project-7/); +- Chrome Extends: + - [instructions](http://mrdoc.zmister.com/project-7/doc-243/); + - [simpread](https://github.com/Kenshin/simpread):[instructions](https://github.com/Kenshin/simpread/issues/893) +- Mobile App(developing) + +## Example Site + +Open Source Edition - [http://mrdoc.zmister.com](http://mrdoc.zmister.com) + +Professional Edition - [https://doc.mrdoc.pro](https://doc.mrdoc.pro) + +username:test1 password:123456 + +## Donate + +

Donate a can of Coffee to the author to speed up the development.

+

+Ko-Fi | +PayPal +

+ +

+ + + +

+ +## Feature + +- **Site Manage & User Manage** + - Support user registration, login, management, administrator and other basic user functions; + - Support site configuration registration invitation code, advertising code, statistics code, email retrieval password, site wide close registration, site wide forced login and other management functions; + - It supports the configuration of the permission of the Project, and provides four permission modes: public, private, visible to the specified user and visible to the access code; + +- **Document System** + - Document writing and reading are based on the Project, with five modules, namely **project**, **document**, **document template**, **image** and **attachment**; + - The `markdown` editor based on `editormd` and `vditor` is used to optimize and extend, and the `markdown` syntax is used for document writing, and image management and uploading, table pasting, mind mapping, flow chart drawing and sequence diagram drawing are supported; + - Two column **document reading** page, three-level directory level display, document reading font scaling, font type switching, page social sharing, mobile reading optimization, text collection export PDF, ePub file; + - Support the account based `API` interface, which can use the account `token` to get the corpus, upload pictures and create documents through the 'API'; + - Supports the project collaboration function. A project can have one Creator and multiple collaborators, and can flexibly select collaboration permissions; + - It supports the function of document historical version to view and compare the differences between the historical version and the existing version, and restore a historical version to the current version; + +Update Record : [CHANGES.md](./CHANGES.md) + +## Simple Installation Tutorial + +### 1. install dependent modules +``` +pip install -r requirements.txt +``` + +### 2. Initialize database + +After installing the required third-party library and configuring the database information, we need to initialize the database. + +Open the command line interface under the project path and run the following command to generate the database migration: + +``` +python manage.py makemigrations +``` + +Run the following command to perform database migration: + +``` +python manage.py migrate +``` + +After execution, the database is initialized. + +### 3. Create Super User + +After initializing the database, you need to create an administrator account to manage the whole mrdoc. Open the command line terminal in the project path and run the following command: + +``` +python manage.py createsuperuser +``` + +Follow the prompts to enter the user name, email address and password. + +### 4、Test Running + +After completing the above steps, you can run and use mrdoc. + +In the test environment, you can use the server provided by Django to run mrdoc. The command is: + +``` +python manage.py runserver +``` + + +## Third party deployment tools + +- [Docker Image](https://registry.hub.docker.com/r/jonnyan404/mrdoc-nginx) +- [Linux Deployment Script](https://gitee.com/jonnyan404/oh-my-mrdoc) +- [Windows Deployment Pannel](https://gitee.com/debj031634/win-django) + +## Feedback + +### 1. Commit Issue + +Submit questions on the following pages: + +- [https://gitee.com/zmister/MrDoc/issues](https://gitee.com/zmister/MrDoc/issues) +- [https://github.com/zmister2016/MrDoc/issues](https://github.com/zmister2016/MrDoc/issues) + +### 2. Join the mrdoc communication group + +Join the mrdoc communication Tencent QQ group ,Group number: + + - **735507293** + - **849206042** + +### 3. Contact author + +WeChat Subscription : **zmister2016** + +## Dependent + +Thanks for the development based on the following projects: + +- Python +- Django +- Jquery +- LayUI +- PearAdminLayui +- Editor.md +- Marked +- CodeMirror +- Echarts +- Viewer.js +- Sortable.js +- Vditor +- TinyMCE + +## License + +GPL-3.0 + +Business License Contact:zmister@qq.com \ No newline at end of file diff --git a/README.md b/README.md index b3f9f3b..52204ef 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,13 @@ -

MrDoc - Writing documents, Gathering ideas

+

觅思文档开源版

-

Personal and small team notes, documents, knowledge management privatization deployment scheme

+

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

中文介绍 | English Description

+

@@ -14,50 +15,63 @@

-Home | -Example Site | -QQ Group - +官网 | +演示站点 | +QQ群

-Installation Manual | -User Manual | -Document Example +安装手册 | +使用手册 | +文档效果

- -

Source code:Gitee | +

源码:码云 | GitHub

+## 简介 -### Introduce +`MrDoc` 是基于`Python`开发的在线文档系统,适合作为个人和小型团队的私有云文档、云笔记和知识管理工具。致力于成为优秀的私有化在线文档部署方案。 -`Mrdoc` is an online document system developed based on python. It is suitable for individuals and small teams to manage documents, knowledge and notes. It is committed to become a private online document deployment solution for the whole platform (web, desktop, mobile). +目前涵盖终端: -Current Platform: +- Web端 +- Chrome扩展: + - [MrDoc官方插件](https://gitee.com/zmister/mrdoc-webclipper):[使用说明](http://mrdoc.zmister.com/project-7/doc-243/); + - [简悦扩展](https://github.com/Kenshin/simpread):[使用说明](https://github.com/Kenshin/simpread/issues/893) -- Web,[instructions](http://mrdoc.zmister.com/project-7/); -- Chrome Extends: - - [instructions](http://mrdoc.zmister.com/project-7/doc-243/); - - [simpread](https://github.com/Kenshin/simpread):[instructions](https://github.com/Kenshin/simpread/issues/893) -- Mobile App(developing) +开发中的终端: -## Example Site +- 手机APP -Open Source Edition - [http://mrdoc.zmister.com](http://mrdoc.zmister.com) +计划中的终端: -Professional Edition - [https://doc.mrdoc.pro](https://doc.mrdoc.pro) +- 桌面客户端 -username:test1 password:123456 -## Donate +## 演示站点 -

Donate a can of Coffee to the author to speed up the development.

-

-Ko-Fi | -PayPal +开源版 - [http://mrdoc.zmister.com](http://mrdoc.zmister.com) + +专业版 - [https://doc.mrdoc.pro](https://doc.mrdoc.pro) + +开源版与专业版差异 - [https://doc.mrdoc.pro/project-7/doc-3441/](https://doc.mrdoc.pro/project-7/doc-3441/) + +用户名:test1 密码:123456 + +## 打赏支持 + +

「付费部署服务」请添加作者QQ:3280350050

+ +

请作者喝一罐红牛,助他天天能迭代,日日可更新。打赏赞助鸣谢榜

+ +

+微信| +支付宝| +QQ| +PayPal | +Ko-Fi

@@ -66,98 +80,100 @@ username:test1 password:123456

-## Feature -- **Site Manage & User Manage** - - Support user registration, login, management, administrator and other basic user functions; - - Support site configuration registration invitation code, advertising code, statistics code, email retrieval password, site wide close registration, site wide forced login and other management functions; - - It supports the configuration of the permission of the Project, and provides four permission modes: public, private, visible to the specified user and visible to the access code; - -- **Document System** - - Document writing and reading are based on the Project, with five modules, namely **project**, **document**, **document template**, **image** and **attachment**; - - The `markdown` editor based on `editormd` and `vditor` is used to optimize and extend, and the `markdown` syntax is used for document writing, and image management and uploading, table pasting, mind mapping, flow chart drawing and sequence diagram drawing are supported; - - Two column **document reading** page, three-level directory level display, document reading font scaling, font type switching, page social sharing, mobile reading optimization, text collection export PDF, ePub file; - - Support the account based `API` interface, which can use the account `token` to get the corpus, upload pictures and create documents through the 'API'; - - Supports the project collaboration function. A project can have one Creator and multiple collaborators, and can flexibly select collaboration permissions; - - It supports the function of document historical version to view and compare the differences between the historical version and the existing version, and restore a historical version to the current version; +## 适用场景 -Update Record : [CHANGES.md](./CHANGES.md) +个人云笔记、在线产品手册、团队内部知识库、在线电子教程等私有化部署场景。 -## Simple Installation Tutorial +## 功能特性 -### 1. install dependent modules +- **站点管理** + - 用户注册、用户登录、用户管理、图片管理、附件管理、文档管理、文集管理、注册邀请码配置、全站关闭注册开关、全站强制登录开关; + - 广告代码配置、统计代码配置、站点信息配置、备案号配置; + - 附件格式配置、附件大小配置、图片大小配置; + +- **个人管理** + - 文集管理:新建、删除、权限控制、转让、协作、导出、生成电子书格式文件 + - 文档管理:新建、删除、回收站、历史版本 + - 文档模板管理:新建、删除 + - 图片管理:上传、分组、删除 + - 附件管理:上传、删除 + - Token管理:借助Token高效新建和获取文档; + - 个人信息管理:修改昵称、修改电子邮箱、切换文档编辑器; + +- **文档书写** + - 文本文档、表格文档两种文档类型,`Markdown` 、富文本两种编辑模式,`Editor.md`、`Vditor`、`iceEditor`三种编辑器加持,自由选择、自由切换; + - 图片、附件、科学公式、音视频、思维导图、流程图、Echart图表; + - 文档排序、文档上级设置、文档模板插入; + - 文档标签设置; + +- **文档阅读** + - 两栏式布局,三级目录层级显示,左侧文集大纲,右侧文档正文; + - 文档阅读字体缩放、字体类型切换、页面社交分享、移动端阅读优化; + - 文集EPUB、PDF文件下载,文档Markdown文件下载; + - 标签关系网络图; + - 文档全文搜索; + - 私密文档分享码分享 + +完整更新记录详见:[CHANGES.md](./CHANGES.md) + +## 简明运行教程 + +### 1、安装依赖库 ``` pip install -r requirements.txt ``` -### 2. Initialize database +### 2、初始化数据库 -After installing the required third-party library and configuring the database information, we need to initialize the database. +在安装完所需的第三方库并配置好数据库信息之后,我们需要对数据库进行初始化。 -Open the command line interface under the project path and run the following command to generate the database migration: +在项目路径下打开命令行界面,运行如下命令生成数据库迁移: ``` python manage.py makemigrations ``` -Run the following command to perform database migration: +运行如下命令执行数据库迁移: ``` python manage.py migrate ``` +执行完毕之后,数据库就初始化完成了。 -After execution, the database is initialized. - -### 3. Create Super User - -After initializing the database, you need to create an administrator account to manage the whole mrdoc. Open the command line terminal in the project path and run the following command: - +### 3、创建管理员账户 +在初始化完数据库之后,需要创建一个管理员账户来管理整个MrDoc,在项目路径下打开命令行终端,运行如下命令: ``` python manage.py createsuperuser ``` +按照提示输入用户名、电子邮箱地址和密码即可。 -Follow the prompts to enter the user name, email address and password. +### 4、测试运行 +在完成上述步骤之后,即可运行使用MrDoc。 -### 4、Test Running - -After completing the above steps, you can run and use mrdoc. - -In the test environment, you can use the server provided by Django to run mrdoc. The command is: +在测试环境中,可以使用Django自带的服务器运行MrDoc,其命令为: ``` python manage.py runserver ``` +## 第三方部署工具 -## Third party deployment tools +- [Docker镜像](https://registry.hub.docker.com/r/jonnyan404/mrdoc-nginx) +- [Linux一键部署脚本](https://gitee.com/jonnyan404/oh-my-mrdoc) +- [Windows部署面板](https://gitee.com/debj031634/win-django) -- [Docker Image](https://registry.hub.docker.com/r/jonnyan404/mrdoc-nginx) -- [Linux Deployment Script](https://gitee.com/jonnyan404/oh-my-mrdoc) -- [Windows Deployment Pannel](https://gitee.com/debj031634/win-django) +## 交流 -## Feedback +

微信公众号:州的先生(ID:zmister2016)

+ -### 1. Commit Issue +

QQ群:735507293

+

QQ群2:849206042

-Submit questions on the following pages: +## 依赖 -- [https://gitee.com/zmister/MrDoc/issues](https://gitee.com/zmister/MrDoc/issues) -- [https://github.com/zmister2016/MrDoc/issues](https://github.com/zmister2016/MrDoc/issues) - -### 2. Join the mrdoc communication group - -Join the mrdoc communication Tencent QQ group ,Group number: - - - **735507293** - - **849206042** - -### 3. Contact author - -WeChat Subscription : **zmister2016** - -## Dependent - -Thanks for the development based on the following projects: +觅思文档基于以下项目进行开发,在此表示感谢: - Python - Django @@ -173,8 +189,12 @@ Thanks for the development based on the following projects: - Vditor - TinyMCE -## License +## 协议 GPL-3.0 -Business License Contact:zmister@qq.com \ No newline at end of file +开源版的使用者必须保留 MrDoc 和觅思文档相关版权标识,禁止对 MrDoc 和 觅思文档相关版权标识进行修改和删除。 + +如果违反,开发者保留对侵权者追究责任的权利。 + +商业授权(专业版)请联系QQ咨询:3280350050 \ No newline at end of file diff --git a/delete_note.sh b/delete_note.sh index d951b0d..05df46f 100644 --- a/delete_note.sh +++ b/delete_note.sh @@ -1,6 +1,6 @@ #!/bin/bash -PASSWD="Qax318130843#$." +PASSWD="" echo ${PASSWD} MKDIR (){ for DIR in txt diff --git a/import_pic.sh b/import_pic.sh index 3290c08..4b3266a 100644 --- a/import_pic.sh +++ b/import_pic.sh @@ -1,4 +1,4 @@ #!bin/nash qshell qupload upload.conf -mysql -uroot -pQax318130843#$. -e "use note;update app_doc_doc set pre_content=REPLACE(pre_content,'(/media/','(http://cdn.imbed.liuyan.wang/note/media/') where pre_content like '%(/media/%';" -mysql -uroot -pQaz318130843#$. -e "use note;update app_doc_doc set content=REPLACE(content,'src=\"/media/','src=\"http://cdn.imbed.liuyan.wang/note/media/') where content like '%src=\"/media/%';" +mysql -uroot -p -e "use note;update app_doc_doc set pre_content=REPLACE(pre_content,'(/media/','(http://cdn.imbed.liuyan.wang/note/media/') where pre_content like '%(/media/%';" +mysql -uroot -p -e "use note;update app_doc_doc set content=REPLACE(content,'src=\"/media/','src=\"http://cdn.imbed.liuyan.wang/note/media/') where content like '%src=\"/media/%';"