BriterWrite. Publish. Own it.

Documentation

Writing & Publishing

The editor, autosave, scroll-sync, preview tokens, and the post lifecycle.

Writing & Publishing

Open /write/new to start a post, or click an existing post from the dashboard to edit it.

The editor

The editor is two panes: Markdown on the left, live preview on the right.

Keyboard shortcuts:

  • Ctrl+S / Cmd+S — save draft immediately
  • Autosave fires 1.5 seconds after you stop typing — no manual save required

Scroll sync — scroll the Markdown pane and the preview follows heading-by-heading. Works in both directions.

Images

Paste an image from the clipboard or drag and drop a file onto the Markdown pane. Briter uploads it immediately and inserts the Markdown at the cursor.

Supported formats: JPEG, PNG, WebP, AVIF, GIF.

See Images & pipeline for details on variants, EXIF stripping, and storage budget.

Post status lifecycle

draft → scheduled → published → archived
  • Draft — draft: true. Saved but not published. Visible only to you (with a session or a preview token).
  • Scheduled — has a publishedAt datetime in the future. The worker holds it and publishes at that instant.
  • Published — live at /posts/<slug> (built-in reader) or committed to the external site (git-target adapter).
  • Archived — archived: true. Hidden from the public site; the file is kept and the change is reversible (clear the flag to restore).

Status is derived from frontmatter, with archived taking precedence over everything. See Scheduling & archiving for the full rules.

Dashboard filters

The dashboard shows tabs: Drafts, Scheduled, Published, Failed sync. Use the search box to filter by title across all tabs.

Failed sync shows posts whose git-sync job was dead-lettered after BRITER_WORKER_MAX_ATTEMPTS (default 8) failed attempts. Click a post to see its lastError; re-saving enqueues a fresh attempt. See Worker & Queue.

Preview tokens

Click Share preview in the editor toolbar. Briter generates a 24-hour shareable link (/preview/<slug>?token=...) that lets anyone — even without a login — view the draft.

Preview tokens are HMAC-signed and expire. They do not grant write access.

Frontmatter

Briter writes frontmatter automatically. You can edit it directly in the Markdown:

---
title: My Post Title
summary: A one-line description shown in the post list.
publishedAt: 2024-03-15
tags: [writing, tools]
draft: false
---
  • publishedAt (full ISO-8601 datetime) in the future → post is scheduled and held until that instant
  • draft: true → post is never surfaced publicly regardless of date
  • archived: true → post is hidden from the public site; reversible

See Scheduling & archiving for details.