Skip to content

rogue-socket/markit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

mdgrill

Annotate markdown files on macOS. Highlight text, add comments, export everything to your clipboard. Your source files are never touched.

A lightweight, native macOS markdown annotation tool built with Swift and SwiftUI. Read markdown with rendered previews, select passages, attach notes, and export annotated quotes — perfect for code review, document feedback, research notes, and editorial markup. No Electron, no web app, no account required.

Screenshot

mdgrill app screenshot

Key features:

  • Render any .md file with full GitHub-flavored markdown support
  • Select text and attach inline comments
  • Yellow highlights mark all annotations
  • Export all quote+comment pairs to clipboard in one shortcut
  • Annotations stored in sidecar JSON — source files are never modified
  • Dark mode support
  • Configurable keyboard shortcuts
  • Single binary, under 600KB, launches instantly

Download

Grab the latest release from GitHub Releases.

  1. Download mdgrill-macos.zip
  2. Unzip and drag mdgrill.app to /Applications
  3. (Optional) Add the CLI shim to your PATH:
    curl -sL https://raw.githubusercontent.com/rogue-socket/markit/main/mdgrill -o /usr/local/bin/mdgrill && chmod +x /usr/local/bin/mdgrill

Build from source

make build

Produces .build/mdgrill.app.

Install from source

make install

Copies the app to /Applications/mdgrill.app.

Then copy the CLI shim to somewhere on your PATH:

cp mdgrill /usr/local/bin/mdgrill

Usage

mdgrill path/to/file.md

Opens the file rendered in a single window. Close the window to quit.

Annotating

Action Shortcut
Add comment Cmd+Shift+C
Save comment Cmd+Return
Cancel Esc
Export all to clipboard Cmd+E
Delete annotation Click highlight → Delete

Select text, press Cmd+Shift+C, type your comment, press Cmd+Return. A yellow highlight marks the annotation. Click any highlight to view or delete it.

Export format

Cmd+E copies all annotations to the clipboard as:

> quoted text

your comment

---

Storage

Annotations are stored in ~/.mdgrill/annotations/<hash>.json (one file per source document, keyed by SHA-256 of the absolute path). Source .md files are never modified.

Data on disk

The only files mdgrill writes are in ~/.mdgrill/:

~/.mdgrill/
├── annotations/          # one JSON file per annotated document
│   ├── <sha256>.json
│   └── ...
└── config.json           # optional shortcut overrides

No temp files, no caches, no background processes. Closing the window (Cmd+W) terminates the app and frees all memory. Sidecar JSONs remain on disk so annotations survive restarts.

# See what's accumulated:
ls -lh ~/.mdgrill/annotations/

# Remove annotations for a specific file:
rm ~/.mdgrill/annotations/<hash>.json

# Remove all annotations:
rm -rf ~/.mdgrill/annotations/

Configuration

Edit ~/.mdgrill/config.json to override shortcuts:

{
  "shortcuts": {
    "add_comment": "cmd+shift+c",
    "export": "cmd+e"
  }
}

Supported modifiers: cmd, shift, alt/option, ctrl. Changes take effect on relaunch.

Development

Rebuild and relaunch in one step:

make run FILE=/path/to/file.md

This kills any running instance, rebuilds, and opens the app with the given file.

Requirements

  • macOS 13+
  • Swift 5.9+
  • Xcode Command Line Tools

About

Annotate markdown files on macOS — highlight text, add comments, export to clipboard. Native Swift app, no Electron. Source files never modified.

Topics

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors