Welcome to cmdocs

cmdocs Open Graph

cmdocs turns a folder of MDX files into a fast, fully static documentation site. You write content, cmdocs handles routing, theming, search, and deployment.

What you write

A cmdocs project is just a config file and some MDX pages:

docs.json

index.mdx

quickstart.mdx

setup.mdx

logo.svg

{
  "name": "My Docs",
  "navigation": {
    "tabs": [
      {
        "label": "Documentation",
        "path": "documentation",
        "groups": [
          {
            "label": "Getting Started",
            "pages": [
              { "file": "index" },
              { "file": "quickstart" }
            ]
          }
        ]
      }
    ]
  }
}

---
title: Welcome
description: My project's documentation.
---

# Hello World

This is my first page. Use any built-in component:

<Callout type="info">
  No imports needed — components just work.
</Callout>

How it works

cmdocs takes your MDX content and config, runs them through a build pipeline, and produces a fully static site you can deploy anywhere.

What you get

A fully static site with dark mode, search, syntax highlighting, and responsive design built in. The cmdocs Dashboard handles builds, hosting, subdomains, and HTTPS — just push to deploy.

Three commands

npx @cmdoss/cmdocs init my-docs   # scaffold a new project
npx @cmdoss/cmdocs dev            # run locally with hot reload
npx @cmdoss/cmdocs check          # validate docs before pushing