whatisgithub

What is markdown-preview?

pluk-inc/markdown-preview — explained in plain English

Analysis updated 2026-05-18

1,346SwiftAudience · generalComplexity · 1/5LicenseSetup · easy

In one sentence

A native macOS app for viewing and lightly editing Markdown files, with support for diagrams, math equations, and sending files to AI chat tools.

Mindmap

mindmap
  root((Markdown Preview))
    What it does
      Native macOS viewer
      Light Markdown editing
      Quick Look support
    Tech stack
      Swift and AppKit
      WKWebView rendering
      swift-markdown parser
    Use cases
      Fast file preview
      Diagram and math render
      Send file to AI chat
    Audience
      Mac users
      Writers and developers
    Notes
      Homebrew installable
      MIT licensed

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

What do people build with it?

USE CASE 1

Preview Markdown files with a native, fast Mac app instead of a browser or Electron viewer.

USE CASE 2

Edit a Markdown file's headings, lists, and formatting directly in the preview window.

USE CASE 3

Send the current Markdown file to Claude, ChatGPT, or Codex for AI assistance.

USE CASE 4

Open and preview Markdown files or folders straight from the command line with mdp.

What is it built with?

SwiftAppKitWKWebViewswift-markdown

How does it compare?

pluk-inc/markdown-previewsignerlabs/shipswifteeliberto/ipa-download
Stars1,3461,3951,469
LanguageSwiftSwiftSwift
Last pushed2026-06-21
MaintenanceMaintained
Setup difficultyeasyeasyeasy
Complexity1/52/52/5
Audiencegeneraldevelopergeneral

Figures from each repo's GitHub metadata at analysis time.

How do you get it running?

Difficulty · easy Time to first run · 5min

Requires macOS 15 or later on Apple Silicon or Intel, install via Homebrew cask or a signed DMG from the releases page.

You can use, modify, and share this freely, including for commercial purposes, as long as you keep the copyright notice.

So what is it?

Markdown Preview is a native Mac app for reading and lightly editing Markdown files without opening a code editor or a browser tab. You can drop a .md file onto its icon, set it as the default app for Markdown files, or use the Finder spacebar Quick Look preview, and get a clean, scrollable rendering of the document with a sidebar outline built from its headings that you can click to jump around. Beyond just viewing, it has an Edit Mode with a formatting toolbar for headings, emphasis, lists, quotes, code, and links, so you can make quick changes and save directly from the app. It renders Mermaid diagrams and LaTeX style math equations right inside the preview, both in the full app and in Quick Look, using bundled renderers so this works without an internet connection. There is also in document search, a file metadata inspector panel, adjustable zoom levels for the preview text, and a customizable toolbar following normal Mac conventions. A few features are aimed specifically at people who work with AI tools: an Open in LLM button that sends the current file to Codex, Claude, or ChatGPT with as much file or folder context as those apps support, and a Share and Copy behavior that copies the raw Markdown source text rather than a file link, which is convenient for pasting into a chat window. The app can also register command line tools like mdp so you can open Markdown files or whole folders straight from the terminal, and it can hand a file off to a real code editor such as VS Code, Cursor, or Zed with one click. The app requires macOS 15 or later on either Apple Silicon or Intel Macs, and can be installed through Homebrew or as a signed and notarized download from the releases page. It is open source, built with Swift, and released under the MIT license, with optional anonymous crash reporting that can be turned off from within the app.

Copy-paste prompts

Prompt 1
Help me install Markdown Preview using Homebrew on my Mac.
Prompt 2
Show me how to enable Edit Mode and format text in Markdown Preview.
Prompt 3
Explain how the Open in LLM feature sends my file to Claude or ChatGPT.
Prompt 4
Walk me through setting up the mdp command line tool from the app menu.
Prompt 5
Help me set Markdown Preview as my default app for .md files.

Frequently asked questions

What is markdown-preview?

A native macOS app for viewing and lightly editing Markdown files, with support for diagrams, math equations, and sending files to AI chat tools.

What language is markdown-preview written in?

Mainly Swift. The stack also includes Swift, AppKit, WKWebView.

What license does markdown-preview use?

You can use, modify, and share this freely, including for commercial purposes, as long as you keep the copyright notice.

How hard is markdown-preview to set up?

Setup difficulty is rated easy, with roughly 5min to a first successful run.

Who is markdown-preview for?

Mainly general.

Open on GitHub → Ask about another repo

This repo across BitVibe Labs

Verify against the repo before relying on details.