Skip to content

gcclinux/Easyeditor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

438 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Easyeditor 🚀

🏠 Home | 💻 Code | 🌐 WebApp

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!

Infographic


Easyeditor

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.

Download Latest Release

🐳 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:latest

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.

Try Easyeditor Online


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:

  • All Platforms: Install Visual Studio Code, Kiro, Antigravity, VSCodium or any other prefered IDE
  • Linux: Install libwebkit2gtk-4.1-dev, build-essential, curl, wget, libssl-dev, libayatana-appindicator3-dev, librsvg2-dev.
  • Windows: Install additional extention C++ workload would help.
  • macOS: xcode-select --install

Then run:

# Development
npm run dev

# Production Build
scripts\build-tauri.bat
scripts\build-snap.sh
scripts\build-docker.sh
npm run tauri:build `**Linux Specific**`

Feature Showcase

🎨 Stunning Themes

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

Themes

📊 Powerful Diagrams & Math

Visualize your ideas with Mermaid charts and KaTeX equations.

KaTeX Example:

KaTeX Example

Template Online Gallery:

Online Templates

🐙 EasyGit Integration

Seamlessly manage your version control without leaving the editor.

Git Feature

📝 Table Support

Clean and responsive table rendering.

Feature Support
Markdown
Mermaid
KaTeX
SSTP Encryption

License

This project is licensed under the Open Source (MIT) license with Commons Clause and Trademark Protection.

What this means:

✅ Open Source - Anyone can view, modify, and use the code
✅ Community Contributions - Improvements must be shared back
✅ Free to Use - No cost for personal or internal use
❌ No Commercial Sale - Cannot sell EasyEditor or derivatives
❌ No Rebranding - Cannot rebrand as "EasyEditor Pro" or similar
❌ No Proprietary Forks - Cannot create closed-source versions

You can:

Use Easyeditor for any purpose (free)
Modify the code for your needs
Use it in your projects (non-commercially)
Distribute modified versions (non-commercially, with attribution)
Contribute improvements back to the project

You cannot:

Sell Easyeditor or any derivative
Offer Easyeditor as a paid service
Charge for hosting or support
Rebrand it as your own product
Create proprietary versions
Remove attribution or license notices

Quick Links

Home Docs Infographic Releases GitHub Stars License

Support & Community

Issues Discussions Buy Me A Coffee

About

Easyeditor is an easy markdown editor that allows you to professionally write MarkDown (MD), Mermaid, PlantUML, KaTeX and preview it in real-time. Import only MD, Templates and Docx. You can save, load .md files and export to PDF, PNG, TXT & SSTP

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

  •  

Packages

 
 
 

Contributors