Getting Started

Your documentation deserves a home that works the way your team does. Write in a polished web editor, keep docs next to your code, or both — Meldoc keeps everything in sync.

What is Meldoc?

Think Notion or Confluence, but without the bloat — and with an editor that feels as clean as Obsidian. Write in Markdown, organize visually, publish with a simple command.

Meldoc also comes with a built-in MCP server over your docs. AI tools like Claude, Cursor, or any MCP-compatible agent don’t just read your documentation — they understand your application. Complex features, architecture decisions, how services connect across repos — all of it becomes context your AI can reason about.

How Meldoc is organized

Meldoc uses three building blocks to structure your content:

Workspace is your team’s home base. It holds everything — projects, team members, settings, and assets. Dundler Paper Co. built DundlerOS — a platform for paper orders, clients, and warehouse logistics. Their workspace is “Dundler Paper Co.”

Projects live inside your workspace. Each one groups related documents together. The DundlerOS team has a “DundlerOS API” project for backend docs and a “Warehouse Service” project for inventory and shipping.

Documents are individual pages written in Markdown. Things like “Authentication,” “Order Endpoints,” or “Pretzel Day Scheduler” (yes, someone built that). Each document lives inside a project.

Here’s how that looks in practice:

Dundler Paper Co. (Workspace)
├── DundlerOS API (Project)
│   ├── Authentication
│   ├── Order Endpoints
│   └── Client Management
├── Warehouse Service (Project)
│   ├── Inventory Sync
│   ├── Shipping Integration
│   └── Forklift Safety Override
└── Team Members, Settings, Assets...

Before you dive in, Key Concepts covers a few more ideas — aliases, workflow states, and assets — that come up as you work.

Choose your path

You don’t need to learn everything at once. Pick the path that matches how you want to work — you can always explore the others later.

I just want to write docs

Use the Web Editor — zero setup required. Sign in, create a workspace and a project, and start writing. It’s the fastest way to go from nothing to published documentation.

→ Quick Tour walks you through your first 5 minutes, step by step.

I want docs in my Git repo

Use the Meldoc CLI to sync Markdown files between your repository and the Meldoc server. Your docs get version control, pull requests, and code reviews — while still looking great when published.

→ Meldoc CLI gets you set up with the CLI in minutes.

I want AI assistants to understand my codebase

Use Meldoc MCP to connect tools like Claude, Cursor, or other AI assistants directly to your documentation. Your AI gets full context on your application’s architecture and features.

→ Meldoc MCP shows you how to plug in MCP integration.

What’s next?

Workspaces — Set up your team’s home base and configure it to fit your workflow.

Projects — Organize your docs into projects that make sense for your team.

Documents — Everything about creating, editing, and publishing content.