Skip to content

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

25 Commits

Folders and files

Repository files navigation

Markdown Editor

A fast, native Markdown editor built with Rust, egui, and pulldown-cmark. Write Markdown on the left and see a live rendered preview on the right.

Features

  • Live preview — the right pane renders your Markdown instantly as you type
  • Rendered output — preview is displayed as formatted content (headings, bold, italic, lists, code blocks, tables), not raw HTML
  • File operations — open, save, and save-as support
  • Markdown help — built-in cheat sheet accessible via the Help button in the menu bar
  • Native performance — no Electron, no browser engine; runs as a lean native binary

Screenshots

┌─────────────────────────────────────────────────┐
│ File  │  Help                                   │
├───────────────────┬─────────────────────────────┤
│ Markdown          │ Preview                     │
│                   │                             │
│ # Hello           │  Hello                      │
│                   │                             │
│ **bold** text     │  bold text                  │
│                   │                             │
│ - item one        │  • item one                 │
│ - item two        │  • item two                 │
│                   │                             │
├───────────────────┴─────────────────────────────┤
│ (untitled)                                      │
└─────────────────────────────────────────────────┘

Requirements

  • Rust 1.76 or later
  • macOS, Windows, or Linux (any platform supported by egui/eframe)
  • On macOS: Xcode Command Line Tools (xcode-select --install)

Build & Run

# Clone the repository
git clone <repo-url>
cd markdwoneditor

# Run in development mode
cargo run

# Build an optimized release binary
cargo build --release
# Binary is at: target/release/markdown_editor_rust

Usage

Action How
Open a file File → Open…
Save File → Save
Save to a new path File → Save As…
Show Markdown syntax reference Click Help in the menu bar

Type Markdown in the left pane. The right pane updates the rendered preview automatically.

Dependencies

Crate Version Purpose
eframe 0.29 Native window and event loop
egui 0.29 Immediate-mode GUI framework
egui_commonmark 0.18 Markdown rendering inside egui
pulldown-cmark 0.12 CommonMark-compliant Markdown parser

License

MIT

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages