Skip to content

Latest commit

 

History

History
82 lines (59 loc) · 3.04 KB

README.md

File metadata and controls

82 lines (59 loc) · 3.04 KB

MarkdownViewer — Native Markdown Editor & Previewer for macOS

A lightweight, fast, native macOS Markdown editor and viewer built with SwiftUI. Write and preview Markdown side by side with live rendering, dark mode support, and a clean minimal interface.

macOS Swift SwiftUI License

Screenshots

Preview Mode Editor + Live Preview
Preview Mode Editor Mode

Features

  • Live Preview — Real-time Markdown rendering as you type
  • Split-View Editor — Side-by-side Markdown source and rendered preview
  • Dark / Light Mode — Toggle between dark and light themes, or follow system
  • Code Blocks — Syntax-aware blocks with one-click copy to clipboard
  • Terminal Blocks — Special green styling for bash/shell/zsh code blocks
  • Tables — Full Markdown table support with column alignment and alternating row colors
  • Rich Markdown — Headers, bold, italic, inline code, blockquotes, lists, horizontal rules
  • ASCII Art — Preserves box-drawing characters and monospaced alignment
  • PDF Export — Export to paginated A4 PDF with ⌘E or from the File menu
  • Document-Based — Open, edit, and save .md, .markdown, and .txt files
  • Multi-Document — Work with multiple files at the same time
  • Native macOS — Built with SwiftUI for a fast, lightweight, native experience

Installation

Download

Download the latest .app from Releases.

Build from Source

git clone https://github.com/feherk/MarkdownViewer.git
cd MarkdownViewer
open MarkdownViewer.xcodeproj

Build and run with ⌘R in Xcode.

Usage

Action How
Open a file File → Open (⌘O) or drag & drop
Toggle editor Click the pencil icon in the toolbar
Switch theme Click the sun/moon icon in the toolbar
Copy code block Click the copy icon on any code block
Export to PDF File → Export as PDF (⌘E)

Supported Markdown Syntax

  • Headings — H1 through H4
  • Bold (**text**) and Italic (*text*)
  • Inline code with background highlight
  • Fenced code blocks with language detection
  • Blockquotes
  • Unordered and ordered lists (including indented/nested)
  • Tables with alignment (left, center, right)
  • Horizontal rules (---, ***, ___)
  • ASCII art and box-drawing characters

Requirements

  • macOS 13.0 (Ventura) or later
  • Xcode 15+ (for building from source)

License

MIT License — see LICENSE for details.

Author

Károly Fehér — Concept, design, and project direction

Built with Claude (Anthropic) — AI pair programming