zhangyuheng/MrDoc
1
0
Fork 0
forked from mirror/MrDoc
Code Pull Requests Activity
e620b7cfa7
MrDoc/README.md
zmister ca0eaf4742 0.7.9 归版
2022-05-31 09:04:28 +08:00

6.7 KiB
Raw Blame History

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：

Example Site

Open Source Edition - http://mrdoc.zmister.com

Professional Edition - 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

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 deployment tools

Feedback

1. Commit Issue

Submit questions on the following pages:

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