https://github.com/maskedsyntax/markd
Markd is a fast, clean, and minimal Markdown editor written in Rust
https://github.com/maskedsyntax/markd
Last synced: 4 months ago
JSON representation
Markd is a fast, clean, and minimal Markdown editor written in Rust
- Host: GitHub
- URL: https://github.com/maskedsyntax/markd
- Owner: maskedsyntax
- License: gpl-3.0
- Created: 2025-01-01T20:26:14.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2026-02-17T17:25:27.000Z (4 months ago)
- Last Synced: 2026-02-17T22:19:33.187Z (4 months ago)
- Language: Rust
- Homepage:
- Size: 149 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Markd 📝
Markd is a fast, clean, and minimal Markdown editor written in Rust. It features a GPU-accelerated split-pane interface: a high-performance Markdown text editor on the left and a live, GitHub-style preview on the right.
Built with **GPUI** (the Rust-native GPU-accelerated UI framework used by Zed) for a modern, fluid, and highly responsive experience on Linux.
## Features
- **GPU-Accelerated UI**: Powered by GPUI for high frame rates and low latency.
- **Resizable Split-Pane**: Draggable vertical divider to balance editor and preview.
- **Advanced Code Editor**: High-performance editing with line numbers and syntax awareness.
- **GitHub-Flavored Markdown**: Real-time rendering of headers, blockquotes, tables, links, task lists, and more.
- **Syntax Highlighting**: Beautiful code block highlighting powered by `syntect`.
- **Auto-Render**: Debounced live preview that updates as you type (150ms delay).
- **Status Bar**: Real-time cursor position (line and column) and file encoding.
- **Autosave**: Background task that periodically saves your work every 30 seconds.
- **Native File Operations**: Integrated New, Open, and Save dialogs.
## Installation
### Prerequisites
Ensure you have the following installed:
- Rust toolchain (via [rustup](https://rustup.rs/))
- System dependencies for GPUI (varies by distro, typically `libx11`, `libxkbcommon`, `vulkan-loader`, etc.)
### Build & Run
```bash
cargo run
```
## Architecture
Markd follows a clean, modular architecture:
- **UI Layer**: GPUI components and resizable layouts.
- **Core Layer**: Markdown parsing (`pulldown-cmark`) and rendering engine.
- **IO Layer**: File persistence and background autosave management.
## Keyboard Shortcuts
- **Ctrl+N**: New File
- **Ctrl+O**: Open File
- **Ctrl+S**: Save File
- **Ctrl+R**: Manual Render
- **Ctrl+Shift+R**: Toggle Auto-Render
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.