Getting Started

1. Create an account

Sign up at app.markdown.ing. Email and password — no credit card, everything is free during testing.

2. Run the CLI

No install needed — npx handles everything:

On first run, the CLI detects you're not logged in and starts the authentication flow automatically. It opens your browser to a verification page and shows a device code in the terminal.

Confirm the code in your browser and the CLI connects immediately. Your session is saved to ~/.config/mding/config.json — you won't need to log in again on this machine.

3. Connect a folder

By default, mding-cli watches the current directory. Point it at any folder:

The CLI scans for .md files, connects to markdown.ing over WebSocket, and sends your file tree. Your browser opens automatically.

4. Edit

Your files appear in the editor sidebar. Changes sync bidirectionally in real-time:

• Edit in the browser — file saves to disk immediately
• Edit on disk — browser refreshes the preview instantly

The CLI shows an activity log as files sync back and forth:

5. Disconnect

Press Ctrl+C to stop the CLI. You'll see a session summary with stats:

Your files are untouched on disk. The CLI never modifies files unless you edit them in the browser. No daemon runs in the background after you disconnect.

6. Works over SSH too

SSH into any machine with Node.js and run npx mding-cli. The web editor connects to that remote session — full rich editing, live preview, and diagrams for files on any server. No port forwarding or X11 needed.