Skip to content

sunhouy/EasyPocketMD

Repository files navigation

EasyPocketMD

Build and Deploy

中文  |  Demo

A completely free and open-source lightweight online Markdown editor for mobile devices, built based on Vditor, supporting multi-file management. It provides a visual format insertion method, supports image and file uploads, LaTeX formula referencing, Mermaid chart drawing, lowering the learning and operation threshold. At the same time, the editor also supports multi-device file synchronization, folder creation, historical version management, file sharing, and day/night mode switching. It provides three editing modes (WYSIWYG / instant rendering / split-screen preview), and supports document import, export, and file cloud printing functions.

The project adopts a JavaScript+Python architecture. The backend for login registration, file upload, sharing, historical versions, etc., is implemented using Node, and the cloud printing server and client are implemented using Python.

Usage

The webpage provides two color schemes: day mode and night mode

Day mode Night mode
Switch editor mode Cloud print Share Export format
Format Insert Formula Diagram

Deployment

  • This website implements automatic testing and deployment through GitHub Actions. Please add a .env file in the webpage directory to store sensitive information, in the following format.
DB_HOST=Database address
DB_PORT=Database port
DB_USER=Database username
DB_PASSWORD=Database password
DB_NAME=Database name
ADMIN_USER=Admin username
ADMIN_PASSWORD=Admin password
BASE_URL=Website domain, for example https://md.yhsun.cn
  • Place the Python backend and printing client scripts in the print folder. print_server.py needs to be deployed on the server. Start the server script with the python3 start_print_service.py command. Please deploy the SSL certificate yourself and map it to port 8770 through a reverse proxy.
  • Before running the printing client, you need to install wkhtmltox for HTML to PDF conversion; otherwise, the cloud printing client may not run correctly.

Contact

18763177732@139.com

About

A super-fast, lightweight online Markdown editor for mobile. Offers visual editing tools, image and file uploads, LaTeX support, Mermaid diagram rendering, cross-device file synchronization, multi-file management, version history, file sharing, and dark mode. Provides three editing modes and supports document import/export and cloud printing.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors