Press Space in Finder to preview Markdown with Mermaid, Math/LaTeX, code highlighting, tables, wikilinks, and local-only rendering.
brew install --cask QuartzInkStudio/tap/peekmark
Free and open source. Native Swift, no Electron, no subscription, and no remote document rendering.
| Channel | Current version | Best for | Pro and updates |
|---|---|---|---|
| Mac App Store | 1.0 | The simplest install and automatic updates | Pro Lifetime is an in-app purchase. Restore it with the same Apple Account. |
| Signed Community DMG / Homebrew | 1.0.0 | A direct, signed open-source distribution | Update the direct edition separately. Direct Pro is sold at peekmark.quartz.ink. |
| Build from source | main |
Inspecting, contributing, or building Community yourself | Pro source is not included. |
App Store purchases and direct Quartz licenses are separate entitlements. They are restored through the storefront where they were purchased and do not automatically convert between channels.
| Edition | License | How to get |
|---|---|---|
| Community (free) | AGPL-3.0 | Mac App Store, signed DMG, Homebrew, or build from source |
| Pro (paid once) | Proprietary | Pro Lifetime in the App Store or a direct Quartz license |
The Community edition is fully open source. Pro modules are proprietary and distributed only in official signed binaries.
- ✅ Quick Look extension — render
.mdin Finder (Space bar) - ✅ GitHub-flavored Markdown (GFM)
- ✅ Syntax highlighting (highlight.js)
- ✅ Frontmatter, table of contents, heading anchors, and wikilinks
- ✅ Mermaid diagrams
- ✅ Math / LaTeX rendering
- ✅ Auto light / dark mode
- ✅ System font (SF Pro + SF Mono)
- ✅ Zero remote requests — works offline
- ✅ Menu bar scratchpad and global hotkey
- Workspace / vault browsing
- Backlinks, graph view, and link intelligence
- Advanced document search
- Custom themes and theme editor
- PDF / DOCX / HTML export
- Scratchpad history and quick-capture workflows
Pro is available in the Mac App Store 1.0 and in official direct builds. Pro code is not included in this repository; official binaries load proprietary modules behind compile-time flags and entitlement checks.
Requires macOS 14+, Xcode 16+.
git clone https://github.com/QuartzInkStudio/PeekMark.git
cd PeekMark
open PeekMark.xcodeprojBuild the PeekMark scheme. The Quick Look extension is included.
Quick Look extensions must be embedded in a signed app bundle before Finder can load them reliably. After building or exporting PeekMark, run:
scripts/verify-quicklook.sh /path/to/PeekMark.app /path/to/sample.mdThe script verifies code signatures, registers the app with Launch Services,
resets Quick Look cache, and opens a sample preview with qlmanage -p.
Safe to commit:
- Source code under
QuickMarkApp,QuickMarkCore, andQuickMarkQL project.yml,PeekMark.xcodeproj,scripts/*.sh, CI workflows, docs- Public identifiers such as bundle IDs and public Sparkle update URLs
- Sparkle public EdDSA key (
SUPublicEDKey) when configured
Never commit:
- App Store Connect API keys (
AuthKey_*.p8), Key ID/Issuer ID secret config files - Apple ID, app-specific passwords, notarytool keychain profile exports
- Developer ID certificates,
.p12,.cer, provisioning profiles, private xcconfig files - Sparkle EdDSA private key or any generated release DMG/archive artifacts
Keep release credentials in your local shell/keychain or GitHub Actions secrets.
Pro implementation lives outside this public repository in a private Swift Package. See docs/PRO-ARCHITECTURE.md.
Community edition: AGPL-3.0
Pro modules: Proprietary — see LICENSE-PRO
By submitting a pull request you agree to the Contributor License Agreement. This allows the project to be dual-licensed (AGPL community + proprietary Pro).