1. Create or open
Open the web editor and choose Create your first document. To work with an existing local folder in a supported browser, choose Open a folder and grant only that folder.
Documentation
Choose a surface. Keep the same Markdown.
DocBlocks ships as a web application, desktop app, VS Code extension, and command-line tool. Start with the surface you use, then follow the deeper references for conversion and agent workflows.
Quick start
Create, protect, and publish a document.
The web editor requires no account. These three steps cover the first successful document and the local-first storage choices that matter before you begin real work.
2. Keep a backup
Browser workspaces stay on this device. In Settings, request persistent storage when available, and use Backup browser docs frequently to download a portable copy before clearing browser data or changing devices.
3. Export or share
Open Export and share from the editor toolbar. Export creates a local file. A share link embeds a copy of the document in the URL, so never include secrets and treat anyone with the link as able to read that copy.
Guide index
From first document to automated delivery.
The editor surfaces share the same Markdown model, but each host owns its surrounding chrome and storage boundary. The CLI and MCP references describe their different output and authority rules explicitly.
Web editor
Open the full editor at the site root. Browser workspaces use local storage or folders you explicitly grant.
Desktop app
Use native folders, menus, file opening, and packaged applications on macOS, Windows, and Linux.
VS Code extension
Edit Markdown visually inside VS Code while the host keeps ownership of files, tabs, themes, and save boundaries.
CLI reference
Review every command, argument, stream, output rule, and format direction.
MCP protocol
Understand strict tools, root grants, artifacts, conversion fidelity, resources, budgets, and lifecycle.
Formats
Compare current import and export directions before choosing an editor, CLI, or MCP workflow.
Troubleshooting
Recover without guessing.
DocBlocks keeps failures visible instead of silently treating storage, permissions, or conversion errors as success. Start with the message on screen, then use the matching recovery path below.
A site page opens the editor
Apply the visible DocBlocks update and reload once. The corrected service worker keeps the editor at the site root while product, documentation, privacy, and terms pages use their own routes.
A document will not save
Keep the tab open. Check the storage or conflict banner, free browser space when requested, and choose a conflict branch explicitly. Download all workspaces before clearing site data.
An export fails
The export dialog remains open with the failure detail. Check unreadable images, destination permission, and available storage, then retry. A failed export never reports success or replaces an existing destination silently.
Include the version when asking for help.
Open About DocBlocks to find the version and delivery surface. Include that value, your browser or operating system, and the smallest reproducible document when reporting a problem.
Start with a real document.
The web editor opens immediately, stores documents locally, and requires no account.