MDflow Documentation

Everything you can do in MDflow — the web app, the companion apps, and the developer and AI interfaces.

MDflow is an online markdown workspace for people who want to write in a portable format, share clean documents with readers, and make the same knowledge available to scripts and AI agents. It lives at https://mdflow.cz.

One more thing

And hey - you know what's great about MDflow among other things? You can generate documentations like this one on the fly and have it published automagically on your own domain .-)

Start here

• Never used MDflow? → 02 Quick Start — from a new account to a shared document in five minutes.
• What is this thing? → 01 Welcome to MDflow
• Free or Pro? → 04 Free and Pro Plans
• Connecting Claude or Codex? → 04 Connecting Claude, ChatGPT,...
• Connecting an AI agent? → 03 MCP Servers
• Something is broken? → 03 Troubleshooting
• Need a human? → 01 Support

Contents

01 Getting Started

• 01 Welcome to MDflow — what MDflow is and why plain markdown
• 02 Quick Start — write, save and share your first document
• 03 Signing In and Your Account — sign-in providers, settings, account deletion
• 04 Free and Pro Plans — what each plan includes

02 Writing and Editing

• 01 The Editor — the three views, focus mode, themes
• 02 Markdown Syntax Reference — the supported GitHub Flavored Markdown
• 03 Linking Documents Together — @ mentions and how links behave in shares
• 04 Images — drag, paste, privacy and cleanup
• 05 Saving, Autosave and Drafts — saving, offline resilience, draft recovery
• 06 Version History — diffs, restore, retention (Pro)

03 Organizing Your Work

• 01 Workspaces — keeping projects apart
• 02 Folders and Subfolders — nesting, and the descriptions AI agents rely on
• 03 Managing Documents — rename, move, duplicate, favorite, download, delete
• 04 Search — what is searchable and what is not
• 05 Collections — curated reading sets across workspaces
• 06 Tasks — every markdown checkbox in one filterable list

04 Sharing

• 01 Public Share Links — read-only links anyone can open
• 02 Private Sharing by Email — named people, revocable (Pro)
• 03 Sharing Collections — folder structure or Knowledgebase mode
• 04 Comments — passage comments and moderation
• 05 What Readers See — the experience from the other side of a link

05 Security and Privacy

• 01 Document Encryption — AES-256 in your browser; the server never sees it
• 02 How MDflow Protects Your Data — the privacy characteristics, and the limits
• 03 Deleting Your Account and Data — permanent deletion, and what to export first

06 Import and Export

• 01 Importing Markdown — drag in files or a whole folder tree
• 02 Exporting a Workspace — a self-contained .zip that renders offline

07 Integrations

• 01 GitHub — edit repository markdown, commit straight back
• 02 Google Drive — least-privilege access to files you pick
• 03 Custom Domain — serve share links from your own domain (Pro)

08 Apps and Extensions

• 01 VS Code and Cursor Extension — your workspace inside your editor (Pro)
• 02 iOS App — iPhone and iPad, with Siri, widgets and Face ID
• 03 n8n Node — workflow automation (Pro)

Web Clipper

• 01 Overview and Installation — save web pages as clean markdown
• 02 Connecting to MDflow — token setup and what the errors mean
• 03 Ways to Clip — popup, side panel, context menu, shortcuts
• 04 The Highlighter — mark up pages, clip only what you marked
• 05 Templates — per-site formatting, chosen automatically
• 06 Variables and Filters — pulling data out of a page
• 07 Properties — typed frontmatter on your clips
• 08 AI Interpreter — natural-language extraction with your own model
• 09 Settings, History and Language — and what lives locally rather than in MDflow

09 API and AI Agents

• 01 Personal Access Tokens — what a token grants, and what it cannot reach
• 02 HTTP API — the versioned JSON API (Pro)
• 03 MCP Servers — hosted and local, and how retrieval works (Pro)
• 04 Connecting Claude, ChatGPT and Other Clients — OAuth, no token to paste
• 05 Agent Discovery Files — llms.txt, docs.md, the agent card
• 06 mdflow-crypt CLI — encrypt and decrypt locally

10 Reference

• 01 Keyboard Shortcuts
• 02 Limits and Quotas — every number in one place
• 03 Troubleshooting — the errors people actually hit
• 04 Not Currently Supported — an honest list of what MDflow does not do

Help

• 01 Support — the support form, email, and what to include

Three things worth knowing early

Folder descriptions are the retrieval signal. When an AI agent asks MDflow for context, it ranks folder descriptions above folder names and document titles. A folder called Notes with no description is nearly invisible to an agent. See 02 Folders and Subfolders.

Anything using a Personal Access Token requires Pro — the API, both MCP servers, the Web Clipper, the editor extension, the n8n node. The iOS app is the exception. See 01 Personal Access Tokens.

There is no trash. Deletions are immediate and permanent. Version history (Pro) can recover a document's body, but not a deleted document. See 03 Managing Documents.