MACOS · MARKDOWN

Markdown that Quick Looks right.

A Markdown viewer for macOS.

Scroll for more Quick Look Rendered GFM, MDX, & Obsidian
API.md getting-started.mdx Obsidian.md

Authentication API

Base URL: https://api.peekdown.app/v1

Rate Limiting
All endpoints are rate-limited to 100 requests per minute per API key. Exceeding this returns 429 Too Many Requests.

Endpoints

POST /auth/token

Returns a bearer token for authenticated requests.

ParameterTypeRequiredDescription
client_idstringyesYour application's client ID
client_secretstringyesYour application's client secret
grant_typestringyesMust be client_credentials
curl -X POST https://api.peekdown.app/v1/auth/token \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": "fk_live_abc123",
    "client_secret": "sk_live_xyz789",
    "grant_type": "client_credentials"
  }'
import { Callout } from '@/components/callout'
import { Tabs, Tab } from '@/components/tabs'

Getting Started

Install the toolkit and render your first component in under a minute.

<Callout type="info">
  This guide assumes Node 20 or newer.
  Check with `node --version` before continuing.
</Callout>

Installation

<Tabs items={['npm', 'pnpm', 'yarn']}>
  <Tab value="npm">npm install @acme/toolkit</Tab>
  <Tab value="pnpm">pnpm add @acme/toolkit</Tab>
  <Tab value="yarn">yarn add @acme/toolkit</Tab>
</Tabs>

Your first component

Obsidian Vault Support

Render your Obsidian notes beautifully — callouts, highlights, wikilinks, tags, and more.

Works with Quick Look
Press Space on any note in your vault. Peekdown renders it instantly — no need to open Obsidian.
Full Feature Support
Frontmatter is hidden, `` are stripped, and all 13 callout types are styled with icons.

Highlight key concepts in your notes and link to other pages with wikilinks.

Organize with #tags and #project/research tags. Embed references like diagram.png render as badges.

Don't Forget
Standard markdown still works perfectly — Obsidian syntax is additive.

Today's Notes

  • Draft launch announcement
  • Review Q2 Roadmap with #leadership
  • Migrate vault to #peekdown
  • Walkthrough with design team

Backlinks

Project Charter · Sprint Planning · Design Review

Preview & Edit In Sync
API.md
# Authentication API Base URL: `https://api.peekdown.app/v1` > [!warning] Rate Limiting > All endpoints are rate-limited to 100 requests per minute per API key. Exceeding this returns `429 Too Many Requests`. ## Endpoints ### POST /auth/token Returns a bearer token for authenticated requests. | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `client_id` | string | yes | Your application's client ID | | `client_secret` | string | yes | Your application's client secret | | `grant_type` | string | yes | Must be `client_credentials` | ```bash curl -X POST https://api.peekdown.app/v1/auth/token \ -H "Content-Type: application/json" \ -d '{ "client_id": "fk_live_abc123", "client_secret": "sk_live_xyz789", "grant_type": "client_credentials" }' ``` ### Response

Authentication API

Base URL: https://api.peekdown.app/v1

Rate Limiting
All endpoints are rate-limited to 100 requests per minute per API key. Exceeding this returns 429 Too Many Requests.

Endpoints

POST /auth/token

Returns a bearer token for authenticated requests.

ParameterTypeRequiredDescription
client_idstringyesYour application's client ID
client_secretstringyesYour application's client secret
grant_typestringyesMust be client_credentials
Annotate & Send Back to AI
Roadmap.md

v2.3 Roadmap

A high-level look at where we're taking the product after v2.2 ships. This is a draft — not committed scope. Dates are aspirational and will firm up after the v2.2 retro.

Performance

The big bet for v2.3 is cutting cold-start latency in half. Right now the median session takes 1.8s to first interactive, which is too slow given that competitors are well under 1s. We have a few directions we're exploring.

  • Lazy-load the editor module
  • Precompile the syntax highlighter grammars
  • Move webhook dispatch off the main request thread
+ add a concrete example of a confusing er…

Developer Experience

We've heard consistently from customers that the SDK ergonomics need work. The TypeScript types drift out of sync with the API in ways that surprise people, and our error messages don't tell you what to do next. v2.3 is when we fix that.

soften — don't name competitors directly
Copied to clipboard
<!-- Peekdown annotation export — paste into your AI assistant -->[
  {
    "type": "delete",
    "text": "This is a draft — not committed scope.",
    "paragraph": 1
  },
  {
    "type": "comment",
    "text": "competitors are well under 1s",
    "instruction": "soften — don't name competitors directly",
    "paragraph": 2
  }
]
MORE PEEKDOWN

Built for how you work.

Quick Look Integration.

Say goodbye to raw markdown in Quick Look. Peekdown renders your .md and .mdx files so you no longer have to squint and decipher. You can also copy code snippets - or the entire file - with a single click.

Edit & Annotate.

Making changes or fixing mistakes? Peekdown's got your back with an inline editor that supports 100+ languages & syntax highlighting, plus an annotation feature that can even send your notes back to the AI.

GitHub-Exact Rendering.

This is why I created Peekdown. I got tired of trying to proof my READMEs in a writing app, or with an IDE's default formatting; I just wanted to view my markdown how everyone else would view it, but BEFORE I pushed.

Obsidian Vault Support.

Browse your Obsidian vault right in the Finder with Quick Look, including full support for callouts, wikilinks, highlights, tags, and embeds. Frontmatter is automatically stripped for a clean preview.

Toggleable Checkboxes.

Create a task list (or get your bot to do it) and check off each item as you complete it. You can automatically save with each tick (or not), and see your progress right in Quick Look. One of my favorite features.

AI Ready.

If you're using AI agents, you may eventually work with llms.txt and humans.txt files, which, despite the .txt extension, are actually markdown and will be rendered just like every other markdown file.

COMPARISON

Why not just use VS Code?

Or preview in the browser after pushing?

Peekdown VS Code Browser
Download size ~13MB ~100MB+
Memory usage ~70MB ~500MB+ Tab soup
Startup time Instant Seconds Push first
Quick Look
GitHub-exact Close
(after push)
llms.txt support
Pin on top Extensions
Obsidian syntax Extensions
REVIEWS

What people are saying.

I guess it does more than just show markdown, but that stuff stays out of your way. Looks good, renders right, and even some syntax highlighting.
— derekplucas, App Store
...keeps getting better and better with each update. All the editing and annotation stuff is hidden until you need it. Fast becoming a daily app for me. Looks nice and highly recommend to anyone who wants to preview and edit markdown.
— mdphipps1, App Store
in my opinion, this is the best app for viewing Markdown documents, with rendering identical to GitHub's style. It also includes a built-in editor and Quick Look support.
— An_Original_ID, App Store

Get Peekdown.

Available on the Mac App Store.