English | 简体中文

A fast, lightweight text editor for Markdown, JSON, YAML, and TOML files. Built with Rust and egui for a native, responsive experience.

⚠️ Platform Note: Ferrite is developed and tested on Windows and Linux. macOS support is experimental. If you encounter issues, please report them.

brew tap olaproeis/ferrite
brew install --cask ferrite

This project is 100% AI-generated code. All Rust code, documentation, and configuration was written by Claude (Anthropic) via Cursor with MCP tools.

Raw Editor	Split View	Zen Mode

✨ v0.3.0 (Latest): eframe / egui 0.34.2 platform refresh. PDF + themed HTML export. Executable code blocks (▶ Run). Rendered edit session (one-click WYSIWYG block switching). Split-view scroll sync. User accent color. Mermaid insert toolbar + validation + flowchart polish. Phosphor icons. Session recovery hardening. Quick note workflow. See CHANGELOG.md for full details.

🛠️ Coming in v0.3.1: LSP (diagnostics panel + hover/complete), YouTube embeds, Mermaid second wave, multi-window, CSV editing, and GitHub HTML parity. See ROADMAP.md and prd-v0.3.1.md.

📦 v0.2.6 Highlights: Custom Editor Engine with virtual scrolling (80MB file uses ~80MB RAM), Multi-Cursor Editing, Code Folding, IME/CJK input improvements.

• WYSIWYG Markdown Editing - Edit markdown with live preview, one-click block switching between headings, paragraphs, lists, and table cells in rendered mode, click-to-edit formatting, and syntax highlighting
• Executable Code Blocks - Run shell or Python fenced blocks from rendered/split preview (▶ Run); inline ANSI output, timeout, and Stop (opt-in via Settings; first-run consent)
• Multi-Format Support - Native support for Markdown, JSON, CSV, YAML, and TOML files
• Multi-Encoding Support - Auto-detect and preserve file encodings (UTF-8, Latin-1, Shift-JIS, Windows-1252, GBK, and more)
• Tree Viewer - Hierarchical view for JSON/YAML/TOML with inline editing, expand/collapse, and path copying
• Find & Replace - Search with regex support and match highlighting
• Go to Line (Ctrl+G) - Quick navigation to specific line number
• Undo/Redo - Full undo/redo support per tab

• Split View - Side-by-side raw editor and rendered preview with resizable divider; both panes are fully editable; optional live scroll sync (minimap Sync / 2-way controls)
• Zen Mode - Distraction-free writing with centered text column

• Syntax Highlighting - Full-file syntax highlighting for 100+ languages (Rust, Python, JavaScript, Go, TypeScript, PowerShell, and more)
• Code Folding - Fold/unfold regions with gutter indicators (▶/▼) for headings, code blocks, and lists; collapsed content is hidden
• Semantic Minimap - Navigation panel with clickable header labels, content type indicators, and text density bars (switchable to VS Code-style pixel view)
• Multi-Cursor Editing - Ctrl+Click to add multiple cursors; type, delete, and navigate at all positions simultaneously
• Bracket Matching - Highlight matching brackets ()[]{}<> and emphasis pairs ** __
• Auto-close Brackets & Quotes - Type (, [, {, ", or ' to get matching pair; selection wrapping supported
• Duplicate Line (Ctrl+Shift+D) - Duplicate current line or selection
• Move Line Up/Down (Alt+↑/↓) - Rearrange lines without cut/paste
• Smart Paste for Links - Select text then paste URL to create [text](url) markdown link
• Drag & Drop Images - Drop images into editor to auto-save to ./assets/ and insert markdown link
• Table of Contents - Generate/update TOC from headings with <!-- TOC --> block (Ctrl+Shift+U)
• Snippets - Text expansions like ;date → current date, ;time → current time, plus custom snippets
• Auto-Save - Configurable auto-save with temp-file safety
• Line Numbers - Optional line number gutter
• Configurable Line Width - Limit text width for readability (80/100/120 or custom)
• Custom Font Selection - Choose preferred fonts for editor and UI; important for CJK regional glyph preferences
• Keyboard Shortcut Customization - Rebind shortcuts via settings panel

Native rendering of 11 diagram types directly in the preview:

• Flowchart, Sequence, Pie, State, Mindmap
• Class, ER, Git Graph, Gantt, Timeline, User Journey
• Insert templates - Format toolbar → Insert → Mermaid… for starter snippets per diagram type
• Inline validation - Parse errors in preview with squiggles on broken mermaid blocks in the raw editor
• Flowchart polish - Improved edge routing, extra shapes, style / classDef support; state diagrams support fork/join and history nodes

v0.3.0 Mermaid update: Insert toolbar, syntax help (F1), inline validation, flowchart edge-routing and layout fixes, and state-diagram pseudostates. Complex diagrams may still differ from mermaid.js. See ROADMAP.md for planned parity work.

• Native Table View - View CSV and TSV files in a formatted table with fixed-width column alignment
• Rainbow Column Coloring - Alternating column colors for improved readability
• Delimiter Detection - Auto-detect comma, tab, semicolon, and pipe separators
• Header Row Detection - Intelligent detection and highlighting of header rows

• Workspace Mode - Open folders with file tree, quick switcher (Ctrl+P), and search-in-files (Ctrl+Shift+F)
• Workspace File Index - Ctrl+P and Search in Files scan the entire workspace in the background (not only expanded folders in the tree)
• Quick Note Workflow - Pathless scratch tabs: quit without a save dialog by default; closing a tab still prompts; unsaved notes persist via session recovery (Settings → Files)
• Git Integration - Visual status indicators (modified, added, untracked, ignored) with auto-refresh on save, focus, and file changes
• Session Persistence - Restore open tabs, cursor positions, and scroll offsets on restart; hardened crash recovery with identity checks and disk-conflict banner

• Integrated Terminal - Multiple instances with shell selection (PowerShell, CMD, WSL, bash)
• Tiling & Splitting - Create complex 2D grids with horizontal and vertical splits
• Smart Maximize - Temporarily maximize any pane to focus on work (Ctrl+Shift+M)
• Layout Persistence - Save and load your favorite terminal arrangements to JSON files
• Theming & Transparency - Custom color schemes (Dracula, etc.) and background opacity
• Drag-and-Drop Tabs - Reorder terminals with visual feedback
• AI-Ready - Visual "breathing" indicator when terminal is waiting for input (perfect for AI agents)

• Light & Dark Themes - Beautiful themes with runtime switching; custom Ferrite accent color (Settings / Welcome) for headings, selection, tabs, and chrome
• Document Outline & Statistics - Navigate with outline panel; tabbed statistics showing word count, reading time, heading/link/image counts
• Export & Print - Export to PDF or themed HTML (options dialog, Mermaid as SVG); print preview opens a temp PDF in the in-app viewer; copy as HTML
• Formatting Toolbar - Quick access to bold, italic, headings, lists, links, Mermaid insert, and more
• Phosphor Icons - Consistent icon font across ribbon, toolbar, panels, and preview controls
• Live Pipeline - Pipe JSON/YAML content through shell commands (for developers)
• Custom Window - Borderless window with custom title bar and resize handles
• Recent Files & Folders - Click filename in status bar to access recently opened files and workspace folders
• CJK Paragraph Indentation - First-line indentation options for Chinese (2 chars) and Japanese (1 char) writing conventions

Download the latest release for your platform from GitHub Releases.

# Download the .deb file, then install with:
sudo apt install ./ferrite-editor_amd64.deb

# Or using dpkg:
sudo dpkg -i ferrite-editor_amd64.deb

# Download the .rpm file, then install with:
sudo dnf install ./ferrite-editor.x86_64.rpm

# Or using rpm:
sudo rpm -i ferrite-editor.x86_64.rpm

# Release package
yay -Sy ferrite

# Binary package
yay -Sy ferrite-bin

# Run Ferrite directly from GitHub (no install)
nix run github:OlaProeis/Ferrite

# Drop into a shell that exposes ferrite in PATH
nix shell github:OlaProeis/Ferrite

#