EasyEditor Manual
Complete reference for the EasyEditor Markdown ecosystem — including Tauri native desktop configs, cloud note synchronization, Git operations, and EasyAI persona writing agents.
Overview
EasyEditor is an advanced real-time Markdown editor tailored for professionals, technical writers, and software developers. With support for over 130+ features, it bridges the gap between quick note-taking, rich schema diagrams, and project-level code documentation.
Modern Editor
Live side-by-side Markdown render, Mermaid diagrams, PlantUML syntax, and KaTeX mathematical notation.
EasyNotes Sync
Cloud-connected drafts sidepanel supporting Google Drive, Dropbox, Box, and OneDrive with AES-256 encryption.
EasyAI Agents
Built-in AI personas that act as product analysts, diagram builders, code editors, or professional copywriters.
EasyGit Control
Direct Git GUI integration allowing developers to Clone, Stage, Commit, and Push changes from the editor toolbar.
Getting Started
EasyEditor fits into any environment, whether you want an offline desktop application, a cloud-connected web editor, or a light Docker instance.
Desktop Application (Tauri - Recommended)
Download the pre-compiled installer for your operating system. Tauri makes the application compile directly to machine code, using only ~20MB of RAM without the bloat of Chrome dependencies.
Docker Container
Spin up containerized instances instantly for your local team. Pull the official image from GitHub Container Registry:
docker pull ghcr.io/gcclinux/easyeditor:latest
and run with:
docker run -d --name EASYEDITOR -p 3024:3024 --env-file .env.local ghcr.io/gcclinux/easyeditor:latest
Online Cloud App
Access the editor directly with zero install at easyeditor-cloud.web.app using any modern web browser.
Build from Source
For developers looking to extend features, add custom layouts, or build custom Tauri configurations.
Clone and Install Dependencies
Ensure Node.js (v18+) is installed, then run:
git clone https://github.com/gcclinux/easyeditor.git && cd easyeditor && npm install
Run Local Server
For standard web access, spin up the dev server:
npm run server (runs on http://localhost:3024)
Run Tauri Desktop Mode
Ensure Rust and the build workloads are installed on your OS, then boot the Tauri development environment:
npm run app
The Four Pillars
The EasyEditor ecosystem splits key operations into distinct tools that function seamlessly within a unified interface.
Core Writing Workspace
Handles the live compilation of Markdown markup, applying custom themes (light/dark/minimalist), and compiling inline mathematics or diagram structures using GFM rules.
Cloud Sync & Draft Management
Keeps drafts stored in an offline-first cache on your local device. Provides options to map your document directory to remote cloud services (Google Drive, Dropbox, Box) with automated conflict resolution.
Contextual AI Assistant
An interactive helper pane driven by dedicated AI personas. By reading active workspace files, it generates diagrams, fixes code errors, and rewrites copy without leaving your editing flow.
Native Workspace Versioning
An in-app Git wrapper. Users can stage, commit, and push updates directly to GitHub/GitLab, keeping documentation closely coupled with active development codebases.
Ecosystem Workflow
The typical workflow starts from a simple draft idea and finishes with a version-controlled production document deployed to static hosting.
Initiation (Drafting)
Open a document based on one of the library templates (e.g. AWS Multi-Region architecture, study logs, Daily Journals). Save it to EasyNotes to guarantee real-time cloud backup.
Augmentation (AI Support)
Select sections of your text and use EasyAI personas. Request code bug checking, rewrite sections to meet formal guidelines, or generate Mermaid flowchart structures.
Collaboration (Versioning)
Stage, commit, and push the documents directly into your project's repository using EasyGit, maintaining code and manual files side-by-side.
Finalization (Deployment)
Export the formatted manual to PDF or HTML, or let your CI pipeline automatically sync it with corporate knowledge bases (like Spotify Backstage or GitLab Wiki).
Browser Security & Git Integration
When running EasyEditor in a web browser, sandboxing rules place constraints on filesystem read operations.
.git repository directory.
How to Enable Browser Git Support
Instead of choosing an individual file, click File → Open Repository in your browser (supported in Chrome, Edge, and Opera). Select the folder containing your .git directory. When prompted, click "Allow" or "View files". EasyEditor will scan the root, list all workspace files, and activate all Git operations natively.
Web vs Desktop Features
Choose the correct application target depending on how heavily you use native file access or Git configurations.
| Feature | Electron / Tauri Desktop | Web App (Open Repository) | Web App (Open File) |
|---|---|---|---|
| File Editing | ✅ Yes | ✅ Yes | ✅ Yes |
| Ctrl+S Saving | ✅ Yes (Direct) | ✅ Yes (API) | ✅ Yes (API) |
| Git Repository Detection | ✅ Automatic | ✅ Yes (On Folder Open) | ❌ No |
| Commit & Push GUI | ✅ Yes | ✅ Yes | ❌ No |
| Direct OS Access | ✅ Yes (Unrestricted) | ⚠️ Sandbox Prompts | ❌ Single File Only |
| Offline-first Mode | ✅ Yes | ✅ Yes (Service Worker) | ✅ Yes (Service Worker) |
EasyAI Writing Personas
EasyAI works by executing one of 8 target personas, translating instructions to precise output formats.
| Button | Persona & Goal | Output Constraints | Primary Source |
|---|---|---|---|
| 📝 Markdown | Markdown Specialist. Generates pure structured CommonMark. | No HTML tags, no diagrams. | Prompt Input |
| 🔀 Mermaid | Mermaid Architect. Renders graphs, flowcharts, sequence diagrams. | Valid ```mermaid fenced blocks. |
Prompt Input |
| 📋 User Story | Agile Product Analyst. Produces standard Epic/Backlog formats. | "As a... I want... So that..." + numbered stories. | Prompt Input |
| 📐 ASCII Diagram | ASCII Designer. Generates terminal-safe visual schemas. | Monospace characters only, max 80-cols. | Prompt Input |
| 🏗️ PlantUML | PlantUML Specialist. Generates UML architecture definitions. | Starts with @startuml, ends with @enduml. |
Prompt Input |
| 📊 MD Table | Table Builder. Outputs clean pipe-delimited data matrices. | GFM alignment syntax (`:---`, `---:`). | Prompt Input |
| 🔧 Fix Code | Code review agent. Pinpoints logic flaws and resolves warnings. | Tagged blocks + numbered bug explanations. | Editor File |
| ✍️ Rewrite | Copywriter. Adjusts prose tone, styling, or documentation length. | Replaces original buffer content entirely. | Editor File |
Decision Flow Architecture
This diagram describes how the application determines execution capabilities when opening files based on user environment.
User Action: Open File
│
▼
┌───────────────┐
│ Is Electron? │
└───────┬───────┘
│
┌───────────┴───────────┐
│ │
Yes No
│ │
▼ ▼
┌─────────────────────┐ ┌──────────────────┐
│ Use Electron IPC │ │ Check Browser │
│ • Native Dialog │ │ Capabilities │
│ • Full FS Access │ └────────┬─────────┘
│ • Git Integration │ │
└─────────┬───────────┘ │
│ ┌─────────┴──────────┐
│ │ │
│ Has FS API? No FS API
│ │ │
│ Yes │
│ │ ▼
│ ▼ ┌──────────────────┐
│ ┌──────────────────┐ │ Use File Input │
│ │ showOpenFile │ │ • Browser Dialog │
│ │ Picker() │ │ • Limited Access │
│ │ • Native Dialog │ │ • Download Only │
│ │ • File Handle │ └──────────────────┘
│ │ • Persistent │
│ └────────┬─────────┘
│ │
▼ ▼
┌────────────────────────────────────────────┐
│ Load File Content into Editor │
└────────────────────────────────────────────┘
Quick Reference
At-a-glance limits and configuration locations for system diagnostics.