Skip to content

tmad4000/OpenMarkdownReader

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

162 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OpenMarkdownReader

Homepage: wikihub.md/openmarkdownreader

A beautiful, open-source Markdown file reader and editor for Mac built with Electron.

Features

  • Clean, GitHub-style markdown rendering
  • Syntax highlighting for code blocks
  • Dark mode support (follows system preference)
  • Drag and drop file support
  • Native Mac title bar with traffic lights
  • Multi-tab and multi-window support
  • Edit mode with live preview toggle (⌘E)
  • File browser sidebar with folder navigation
  • Adjustable content width
  • GFM (GitHub Flavored Markdown) support including:
    • Tables
    • Task lists
    • Strikethrough
    • Autolinks

Running

npm start

Keyboard Shortcuts

  • ⌘O - Open file
  • ⌘T - New tab
  • ⌘W - Close tab
  • ⌘E - Toggle edit mode
  • ⌘S - Save
  • ⌘B - Toggle sidebar
  • Escape - Cancel/revert edits
  • Ctrl+Tab - Next tab
  • Ctrl+Shift+Tab - Previous tab

Usage

  1. Open a file: Click "Open File" or press ⌘O
  2. Drag and drop: Drop a .md file onto the window
  3. Edit: Press ⌘E to toggle edit mode
  4. Browse folders: Click the sidebar toggle and open a folder

Supported File Types

  • .md
  • .markdown
  • .mdown
  • .mkd
  • .txt

Notes & Future Plans

App Size (~200MB)

The app is large because Electron bundles a full Chromium browser. This is standard for Electron apps (VS Code, Slack, Discord are similar sizes). The universal binary (ARM + Intel) doubles the size.

Potential optimizations (no current intent to implement):

  • Build single-architecture versions (~100MB each for ARM or Intel separately)
  • Port to Tauri (~15-20MB) which uses the system webview instead of bundling Chromium
  • Port to Neutralino (~3-5MB) for even smaller size

For now, the convenience of Electron's development experience outweighs the size concern.

About

A beautiful, open-source Markdown file reader and editor for Mac

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors