Skip to content
/ emdee Public

A beautiful, fast Markdown viewer for Windows & Linux

License

Notifications You must be signed in to change notification settings

AYJAYY/emdee

Repository files navigation

EmDee

EmDee

A fast, beautiful Markdown viewer for Windows, Linux, and Android.

License


Features

  • Beautiful typography — comfortable reading at any document length
  • GitHub Flavored Markdown — tables, task lists, code highlighting, KaTeX math
  • Three themes — Light, Dark, Sepia — auto-detected from your OS
  • Table of contents — jump-to-section panel with one keystroke
  • Find in document — highlighted matches with Prev / Next navigation
  • Word count & reading time — shown in the toolbar
  • Recent files — quickly reopen documents from the welcome screen
  • Adjustable font size — toolbar buttons on desktop, pinch-to-zoom on Android
  • Export — save as HTML or print to PDF
  • File associations — set EmDee as your default .md viewer
  • Keyboard shortcuts — full keyboard control on desktop
  • Fully offline — no accounts, no telemetry, no tracking

Keyboard Shortcuts

Shortcut Action
Ctrl+O Open file
Ctrl+F Find in document
Ctrl+\ Toggle table of contents
Ctrl+D Toggle dark mode
Ctrl+P Print / PDF
Ctrl+E Export as HTML

Development

System dependencies (Linux, one-time):

sudo apt-get install -y pkg-config libwebkit2gtk-4.1-dev libgtk-3-dev \
  libayatana-appindicator3-dev librsvg2-dev libssl-dev build-essential

Rust (one-time):

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Run in dev mode:

npm run tauri dev

Build for production:

# Linux (.deb, .rpm, .AppImage)
npm run tauri build

# Windows installer (cross-compiled from Linux)
npm run tauri build -- --target x86_64-pc-windows-gnu

Build for Android:

npm run build
npx cap sync android
npx cap open android   # then sign and export from Android Studio

Project Structure

src/
├── adapters/       # Platform abstraction (Tauri / Capacitor / web)
├── components/     # React UI components
├── hooks/          # useMarkdown, useFile, useWordCount
├── store/          # Zustand global state
├── styles/         # Themes, markdown typography, print CSS
└── utils/          # announce, htmlExport
src-tauri/
└── src/lib.rs      # Rust: read_file, get_initial_file commands
android/            # Capacitor Android project
winget-pkgs/        # Winget package manifests
docs/               # Project website (GitHub Pages)

Built with Tauri · Capacitor · React

About

A beautiful, fast Markdown viewer for Windows & Linux

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published