Docs / Quick Start

Quick Start

Published Updated View Markdown source

Markflow is an offline-first Markdown editor that runs entirely in your browser. There is no account, no server and no sync — everything you write is stored locally and stays with your device.

The editor at a glance

The workspace is split into three areas:

Area What it does
Document library Multi-document management with search, favorites and duplicate
Editor pane A CodeMirror editor with Markdown syntax highlighting and a formatting toolbar
Preview pane Live rendered output that scrolls in sync with the editor

You can switch between Edit, Split and Preview layouts at any time, and the preview theme, font, line height and content width are all adjustable in Preferences.

Write your first document

  1. Click New document in the sidebar (or press Alt + N).
  2. Give it a title in the header field — the title is used for exports and share links.
  3. Start typing Markdown. The preview updates as you write.

Try this snippet:

markdown
# My first note

Markflow supports **bold**, *italic* and `inline code`.

- [x] Learned the layout
- [ ] Write something every day

Where your data lives

Everything is saved to your browser's local storage:

  • Documents auto-save a moment after you stop typing.
  • Clearing browser data deletes your documents — export a full backup from Preferences → Data & backup before doing so.
  • The full backup is a single JSON file containing every document, snapshot and preference, and can be restored later.

Version snapshots

Press Ctrl / ⌘ + Shift + S to create a manual snapshot at any milestone. Markflow also takes automatic snapshots before large edits. Open History to preview, download or restore any of the last 20 snapshots.

Share a document

Share compresses the current document into a plain link — the link is the document, nothing is uploaded. Opening the link imports a copy into the visitor's own browser. For long documents, prefer Export → Markdown or the full backup instead.

Keyboard shortcuts

Action Shortcut
Command palette Ctrl / ⌘ + K
Save to browser Ctrl / ⌘ + S
Find & replace Ctrl / ⌘ + H
Focus mode Ctrl / ⌘ + Shift + F

The full list lives in Help → Markdown cheat sheet (Ctrl / ⌘ + /).

Next steps