Markfly.md

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 — GFM tables, task lists, strikethrough, highlighted code blocks, Mermaid diagrams, and LaTeX math
• 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
• Document search — Cmd+F, highlight matches, move with Enter / Shift+Enter
• Drag & drop — drop .md files onto the window; original file path stays available after restart
• 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

In-app updates

Markfly checks GitHub Releases when it starts. Use Help → Check for Updates… to check manually. Update status appears at the bottom of the sidebar; Release Info opens the GitHub release page separately.

When an update is available, choose Download Update, then Open Installer after the package is verified. Confirm installation in macOS Installer and reopen Markfly yourself. Markfly does not silently replace or restart the app. This manual flow does not require an Apple Developer account; because releases are not Developer ID signed, macOS may show a security warning or require approval before opening the installer/app. Fully automatic in-app replacement would require Developer ID-signed releases and a separate updater design.

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.

Releases

Release naming and publishing steps: docs/RELEASING.md.

Security

Dependency audit results and remaining findings: docs/DEPENDENCY-AUDIT.md.

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
Diagrams	Mermaid
Math	KaTeX
Theme stylesheet	github-markdown-css
Packaging	electron-builder
File watcher	chokidar