Markdown Editor

A minimalist, high-performance Markdown editor built with user productivity in mind. Designed for macOS, it combines the speed of a native application with the flexibility of modern web technologies.

Features

• Live Preview: Real-time rendering of Markdown as you type, with accurate GitHub Flavored Markdown support.
• Distraction-Free Interface: Clean, minimalist UI that lets you focus on your writing.
• Rich Formatting Toolbar: Quickly access common formatting options like Bold, Italic, Strikethrough, Code blocks, and more directly from the title bar.
• Integrated Emoji Picker: A centered, keyboard-accessible emoji picker to add personality to your documents.
• Keyboard Shortcuts:
  • Cmd+B: Bold
  • Cmd+I: Italic
  • Cmd+S: Save
  • Cmd+F: Toggle Fullscreen
  • Cmd+O: Open File
  • Cmd+E: Open Emoji Picker
• Code Highlighting: Syntax highlighting for code blocks in the preview.
• Native Experience: Built with Tauri for a lightweight, performant, and secure desktop application experience.

Tech Stack

This project is built using:

• Tauri: For the native application shell and backend.
• React: For the user interface.
• TypeScript: For type-safe code.
• CodeMirror: For the editor component.
• Markdown-it: For Markdown parsing and rendering.

Development

Prerequisites

• Node.js & Bun (or npm/pnpm/yarn)
• Rust (for Tauri)

Setup

1. Clone the repository:

   git clone https://github.com/aneuhaus/md-editor.git
   cd md-editor

2. Install dependencies:

   bun install

3. Run the development server:

   bun run tauri dev

Building for Production

To build the application for macOS:

bun run tauri build

Acknowledgements

• Markdown-it
• CodeMirror
• Tauri
• React
• TypeScript
• Lucide
• Emoji Map Thanks to jonobr1

The output application (.dmg or .app) will be located in src-tauri/target/release/bundle/macos/.

License

MIT