Easyeditor 🚀

The Ultimate Real-Time Markdown Editor for Professionals, Developers & Writers

Easyeditor is not just another Markdown editor—it's a powerhouse for your documentation needs. Write Markdown (MD), create stunning diagrams with Mermaid & UML, render mathematical equations with KaTeX, and preview it all in real-time!

From simple notes to complex technical documentation, Easyeditor has you covered with over 130+ features.

✨ Why You'll Love It

• Real-time Preview: See your changes instantly.
• Rich Diagram Support: Native support for Mermaid, UML, and more.
• Math Ready: KaTeX support for beautiful mathematical notations.
• Template System: Jumpstart your docs with built-in templates.
• Git Integration: Load, stage, commit, and push directly from the editor.
• Export Power: Export to PNG, TXT, PDF, MD and secure SSTP Encryption.
• Customizable: Choose from beautiful themes or create your own!
• SSTP Encryption: SSTP (Simple Security Text Protocol) protection using modern AES-256-CBC encryption!

---

Easyeditor is free, open-source, and yours to modify!

---

Get Started Instantly

📥 Option 1: Download & Install (Recommended)

Skip the build process and start writing immediately! Download the latest system-compiled binary for your OS.

🐳 Option 2: Run with Docker

Prefer a containerized environment? getting up and running is as simple as one command.

# Pull and run the latest version
docker pull ghcr.io/gcclinux/easyeditor:latest
docker run -d --name EASYEDITOR -p 3024:3024 ghcr.io/gcclinux/easyeditor:main

Access it at: http://localhost:3024

🌐 Option 3: Use the Web App

No installation required! Try the full power of Easyeditor directly in your browser.

---

Build from Source

For contributors and those who want to customize the codebase.

Prerequisites

• Node.js & npm
• Git
• Rust (for Tauri Desktop App)

1. Clone & Install

git clone https://github.com/gcclinux/easyeditor.git
cd easyeditor
npm install

2. Run Locally

Web Server Mode:

npm run server

Desktop App Mode:

npm run app

3. Build & Compile (Tauri)

To build the native desktop application provided by Tauri:

First, set up your environment:

• Linux: Install libwebkit2gtk-4.1-dev, build-essential, curl, wget, libssl-dev, libayatana-appindicator3-dev, librsvg2-dev.
• Windows: Install Visual Studio Build Tools with C++ workload.
• macOS: xcode-select --install

Then run:

# Development
npm run tauri:dev

# Production Build
npm run tauri:build

---

Feature Showcase

🎨 Stunning Themes

Select from a variety of themes or create your own to match your style.

📊 Powerful Diagrams & Math

Visualize your ideas with Mermaid charts and KaTeX equations.

KaTeX Example:

Template Online Gallery:

🐙 Git Integration

Seamlessly manage your version control without leaving the editor.

📝 Table Support

Clean and responsive table rendering.

Feature	Support
Markdown	✅
Mermaid	✅
KaTeX	✅
SSTP Encryption	✅

---

Quick Links

Support & Community