Back to Home

Markdown Reader Help

Learn all features in 3 minutes

Quick Start Shortcuts Features Themes & Appearance Diagrams & Formulas CLI Tool Quick Look Export PDF FAQ

Quick Start

Open a file and start reading — it is that simple

1. Open Files or Folders

Press ⌘O to select files, or press ⇧⌘N to create a new independent window. Drag-and-drop is also supported.

2. Read & Seamless Switch

File tree on the left, content in the center, outline on the right. Press ⇧⌘E / ⇧⌘R to switch between rendered and source without losing scroll position.

3. Edit & Line Numbers

Edit directly in source mode, press ⌘S to save. Enable source line numbers in Settings for long-form editing.

4. Quick File Open

Press ⌘P to open the Command Palette, fuzzy search by filename, ↑↓ to select, Enter to open. Faster than browsing.

Shortcuts Reference

Work faster with keyboard shortcuts

ShortcutFunction
⌘NNew File
⇧⌘NNew Window
⌘OOpen Folder / File
⌘SSave File
⇧⌘SSave As
⌥⌘EExport PDF
⌘WClose Window
⌘,Open Settings
⌘\Toggle Sidebar
⇧⌘ERendered Mode
⇧⌘RSource Mode
⌘+Zoom In
⌘-Zoom Out
⌘0Actual Size
⌘FFind
⌘GFind Next
⇧⌘GFind Previous
⌥⌘FFind & Replace
⌘PCommand Palette
⌘?Help

Feature Details

Every feature crafted for a better reading experience

Rendered View

cmark-gfm parses Markdown, WebPage (native macOS 26) renders rich text with full GFM extensions including tables, task lists, strikethrough, and autolinks.

Seamless Mode Switching

Powered by fractional source anchor pipeline (SourceScrollAnchor), keeping your reading position pinpointed between rendered and source modes without jumping.

Source Editing & Line Numbers

Press ⇧⌘R to edit Markdown source directly, with Prism.js highlighting 30+ languages. Optional gutter line numbers in Appearance settings with smooth scrolling.

Native Multi-Window

Press ⇧⌘N to open independent windows. Browse multiple files side-by-side with isolated editing sessions and per-window undo stacks.

Smart File Tree

Recursively browse folders with symlink support and live change monitoring. Option to auto-open containing directory when opening a single file.

Outline Navigation

Auto-extract heading hierarchy, smooth scroll unified to top of viewport for effortless long document reading.

Find & Replace

Press ⌘F for the search bar. Supports case sensitivity, whole words, and regular expressions. ⌥⌘F opens Find & Replace.

View Zoom

Use ⌘+ / ⌘- to zoom (0.3x–3.0x). Press ⌘0 to restore actual size; zoom levels restore automatically.

Command Palette

Press ⌘P to quickly search and open Markdown files in the directory tree with fuzzy matching and keyboard navigation.

Themes & Appearance

33 themes to customize your reading environment

Theme Mode

In Settings → Appearance, choose Light, Dark, or System mode to adapt the application immediately.

Color Schemes

33 preset schemes (20 dark + 13 light) — Dracula, Catppuccin, Nord, Tokyo Night… with independent presets per mode.

Custom Colors

In Settings → Appearance → Custom Colors, adjust background, text, accent, success, and danger colors individually.

Contrast Control

Low and High contrast options to fine-tune visual separation between background and foreground elements.

Diagrams & Formulas

Flawless rendering for technical documentation

Dual Diagram Engines (Mermaid / Pele)

Use `mermaid` language identifier in code blocks. Switch engines in General settings: default Mermaid.js for classic layouts, or Pele for native SVGs that dynamically color-match themes.

Math Formulas (KaTeX)

Use `$...$` for inline formulas and `$$...$$` for block formulas. Crisp LaTeX typography loaded on demand only when formulas are present.

PlantUML Diagrams

Use `plantuml` language identifier to auto-render SVG diagrams. Requires network connection.

CLI Tool mdr

Seamless terminal workflow

Installation

Open Settings → General → Command Line Tool and toggle it on. The `mdr` command is immediately available in your shell.

Usage

Run `mdr README.md` in the terminal to open files, supporting multiple files and directories at once.

More Features

More thoughtful details waiting for you

Quick Look Preview

Select a .md file in Finder and press Space to preview rendered content. Enable in Settings → General → Quick Look Preview.

Copy Document Content

Copy the entire document in one click from rendered mode, source mode, or Quick Look. Turn off in Settings; Quick Look supports rich text or raw Markdown.

Export PDF

Press ⌥⌘E or File → Export PDF to save rendered content as PDF, preserving current theme styles.

FAQ

Having issues? Check here first

What file formats are supported?

Supports `.md`, `.markdown`, `.mdown`, `.mkd` and other Markdown format files.

What are the system requirements?

macOS 26 (Tahoe) or later, natively supporting Apple Silicon.

How to install and upgrade via Homebrew?

Run `brew tap davidhoo/markdownreader && brew install --cask markdownreader`. When upgrading, run `brew upgrade --cask --greedy markdownreader`.

What to do if macOS blocks first launch?

MarkdownReader is developer-signed open source software without Apple Developer paid notarization. If Gatekeeper blocks opening, Control-click the app in Applications and select 'Open', or go to 'System Settings > Privacy & Security' and click 'Open Anyway'.

PlantUML diagrams not rendering?

PlantUML rendering requires a network connection to the server. Offline, Mermaid and Pele diagrams render completely locally.

How to set Markdown Reader as the default app?

Open Settings → General → Default Markdown App and click 'Set as Default'. Or right-click a .md file → Get Info → Open With → select Markdown Reader → click 'Change All'.

How to report issues or suggestions?

Feel free to submit feedback or pull requests on GitHub Issues.