Skip to content

rizkidarmawan21/markfly.md

Repository files navigation

Markfly.md

Markfly

Minimal, native macOS markdown viewer.

Open `.md` files from Finder, preview with GitHub-styled rendering, toggle raw source, auto-reload on file changes.


Features

  • macOS file association — double-click .md in Finder opens in Markfly; right-click > Open With works
  • Rendered preview — GitHub-themed markdown (light & dark), syntax-highlighted code blocks
  • Raw source toggle — switch between rendered HTML and plain markdown
  • Auto-reload — watcher re-reads file on disk changes
  • Dark / light theme — follows system preference, toggle via toolbar
  • Zoom controls — pinch via Cmd±/Cmd+0, or toolbar buttons
  • Drag & drop — drop .md files onto the window
  • Recent files — macOS Open Recent menu and system recents

Install

Option A: PKG (recommended — shows progress & completion)

  1. Download Markfly-<version>-arm64.pkg from Releases
  2. Double-click the .pkg file
  3. Follow the standard macOS installer (requires admin password)
  4. Launch Markfly from /Applications

Option B: DMG (drag-drop, no password)

  1. Download Markfly-<version>-arm64.dmg from Releases
  2. Double-click the .dmg file
  3. Drag Markfly.app into /Applications
  4. Launch Markfly from /Applications

Dev

# install
npm install

# dev (Vite hot-reload + Electron)
npm run electron:dev

# build production
npm run electron:build

Output in release/.dmg, .pkg, and .zip.

Tech Stack

Layer Tech
Desktop shell Electron
UI Vue 3 + TypeScript
Build Vite
CSS Tailwind CSS v4
Markdown renderer marked v18
Syntax highlight highlight.js
Theme stylesheet github-markdown-css
Packaging electron-builder
File watcher chokidar