OscarGodson/EpicEditor
EpicEditor
EpicEditor is a JavaScript-based Markdown editor designed as an embeddable UI component for web applications. It functions as a local-first content manager, utilizing browser local storage for automatic draft saving and offline content persistence.
The editor is distinguished by its use of iframes to isolate styles, preventing CSS leakage between the editor and the host application. It features a customizable Markdown parser that allows developers to replace the default parsing engine with custom functions to transform text into specific output formats.
The system provides a split-pane interface for simultaneous editing and previewing, with support for fullscreen mode and dynamic dimension adjustments. It includes a document management system for creating, renaming, and deleting files, as well as mechanisms to import and export content as text, HTML, or JSON.
Features
- Embeddable Components - Provides an embeddable Markdown editor component with live preview and style isolation for web applications.
- Local-First Document Managers - Functions as a document manager using browser local storage for automatic draft saving and offline persistence.
- Custom Format Renderers - Transforms input text into various output formats like HTML or Markdown via customizable parsing functions.
- Markdown Output Customization - Transforms markdown text into specific output formats by plugging in custom parsing functions and styles.
- Markdown Editors - Implements a web-based text editor with a synchronized split-pane live preview for Markdown content.
- Web Content Authoring Interfaces - Implements a professional writing environment with split-screen editing, automatic drafts, and offline support.
- LocalStorage Persistence - Persists document drafts and metadata in browser local storage to enable offline content management.
- Markdown Parsing Plug-ins - Allows developers to replace the default Markdown parsing engine with custom functions for flexible output rendering.
- Browser Local Storage Management - Manages the creation, renaming, and deletion of documents stored within the browser's local storage.
- CSS Isolation Wrappers - Uses iframes to isolate the editor and previewer styles, preventing CSS conflicts with the host web application.
- Browser-Based Document Managers - Provides a serverless document management system for saving, renaming, and deleting work in local storage.
- Iframe Integration - Integrates the editor and previewer into web applications using iframes to ensure complete style isolation.
- Content Import and Export - Enables importing strings into local storage and exporting content as text, HTML, or JSON.
- Markdown Parsers - Provides a customizable parsing engine that allows developers to replace the default Markdown transformation logic.
- Editor Split Panes - Provides a split-pane interface that synchronizes raw text input with a real-time rendered preview.
- Interface Mode Toggles - Includes a UI toggle to switch between the raw text editing view and the rendered content preview.
- Event-Driven Callbacks - Implements an event-driven system that executes registered callback functions when editor states change or files are saved.
- Embeddable UI Components - Ships as a flexible text editing component that can be themed and resized to fit various application layouts.
- Theme Style Customizations - Offers a system to independently style the interface, input area, and previewer using separate CSS files.
- Custom Stylesheet Injections - Provides the ability to inject custom stylesheets to theme the editor and previewer independently.
- Editor Event Hooks - Provides callback hooks that trigger specific actions when documents are saved, updated, or loaded.
- Editors - Embeddable Markdown editor with preview.
- Rich Text Editors - Embeddable Markdown editor with live preview.
