Editor.md Specific Syntax
MrDoc is developed based on the `Django` framework of the `Python 3` language. Before installing mrdoc, please make sure that the `Python 3` programming language is installed on the target computer. ## Requirement Operating System： - Windows - Linux - macOS Programing Language： - [Python 3.5+](https://www.python.org/) - [pip utils](https://pypi.org/project/pip/) ## 1.Get Source Code Source Code Address: - Gitee：[https://gitee.com/zmister/MrDoc](https://gitee.com/zmister/MrDoc) - GitHub：[https://github.com/zmister2016/MrDoc](https://github.com/zmister2016/MrDoc) ### 1.1、Use Git If GIT software is installed on your computer, you can directly clone the source code to the local computer by using the command `git clone`, command as follows： ``` git clone https://github.com/zmister2016/MrDoc ``` or: ``` git clone https://gitee.com/zmister/MrDoc ``` ### 1.2、Download Source Code ZIP In addition, you can download the compressed file of source code on the homepage of mrdoc project: !(/media/202103/2021-03-21_101404.png) !(/media/202103/2021-03-21_101532.png) Then decompress the zip file ## 2.Install Requirement Open the command terminal in the `/MrDoc/` directory, execute the following command: ```bash pip install -r requirements.txt ``` ## 3.Initialize Database After completing the above steps, you need to initialize the database. > Mrdoc uses SQLite database by default. If you need to use other databases, please refer to the document:[自定义数据库配置](http://mrdoc.zmister.com/project-7/doc-1364/) Open the command terminal in the `/MrDoc/` directory, execute the following command to generate database migration: ``` python manage.py makemigrations ``` Next, run the following command to perform the database migration: ``` python manage.py migrate ``` After execution, the database is initialized. ## 4.Create Admin User After initializing the database, you need to create an administrator account to manage the whole mrdoc,Open the command terminal in the `/MrDoc/` directory, execute the following command: ``` python manage.py createsuperuser ``` Follow the prompts to enter the username, email address and password. ## 5. run MrDoc After completing the above steps, you can run MrDoc. In the test environment, you can use Django's own server to run mrdoc: ```python python manage.py runserver 0.0.0.0 ``` Then visit the local IP address. If the page as shown in the figure below appears, it means that MrDoc has run successfully: !(/media//202003/2020-03-29_210228_1585486987.jpg) If there is no problem with the test run, you can deploy it to the corresponding server. For details, see[《部署指南》](http://mrdoc.zmister.com/project-7/doc-1362/)
March 21, 2021, 10:28 a.m.