Skip to content

Repository files navigation

QuokkaMark

QuokkaMark is a friendly, read-only Markdown navigator for macOS. Open or drop a file, explore its heading outline, search the rendered document, and print or export without opening an editor.

Highlights

  • Native document navigator with click-to-jump headings
  • Full-document search with visible highlighting
  • Finder Quick Look previews
  • Live refresh after another app saves the file
  • Offline Mermaid diagrams and KaTeX equations
  • PDF and standalone HTML export
  • Local-only processing with no account, analytics, or network service
  • Universal Apple Silicon and Intel build

Download

Download the latest QuokkaMark disk image, open it, and drag QuokkaMark to Applications.

The public build is signed with a Developer ID certificate and notarized by Apple for a normal Gatekeeper-approved installation. QuokkaMark requires macOS 13 or newer.

Build from source

Requirements: macOS 13 or newer, Xcode, Swift 5.9+, Node.js, and XcodeGen.

git clone https://github.com/KopitarFan/QuokkaMark.git
cd QuokkaMark
npm install --prefix Vendor
npm run build --prefix Vendor
xcodegen generate
xcodebuild -project QuokkaMark.xcodeproj -scheme QuokkaMark -configuration Release build

For the lightweight local app bundle:

./scripts/build-app.sh
open dist/QuokkaMark.app

Markdown extensions

Mermaid diagrams use fenced code blocks labeled mermaid. Display equations use $$ fences, and inline equations use single dollar signs.

Work log

The public development history lives on the QuokkaMark work log.

License

QuokkaMark is available under the MIT License. Mermaid, Marked, and KaTeX retain their respective licenses.

About

A lightweight, view-only Markdown reader and document navigator for macOS.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages