docmd-io/docmd

Production-ready documentation from Markdown, in seconds.
Zero config. AI-native. Built for developers.

Website  ·  Documentation  ·  Live Editor  ·  Agent Skills  ·  Report a Bug

Quick Start

Run docmd in any folder with Markdown files — no install needed:

npx @docmd/core dev

    _                 _ 
  _| |___ ___ _____ _| |
 | . | . |  _|     | . |
 |___|___|___|_|_|_|___|

 v1.x.x

┌─ Build
│  Engine          JS
│  Source          docs/
│  Output          site/
│  Versions        2 (06, 05)
│  Locales         7 (en, hi, zh, es, de, ja, fr)
└──────────────────────────────────────────────────────────
┌─ Data Indexing
│  [ DONE ] Syncing git metadata
│  [ DONE ] Building semantic search index (multi-version)
└──────────────────────────────────────────────────────────
┌─ Publishing
│  [ DONE ] Generated robots.txt
│  [ DONE ] Generated .nojekyll (disables Jekyll on GitHub Pages)
│  [ DONE ] Generated sitemap
│  [ DONE ] Generating LLMs context files
└──────────────────────────────────────────────────────────

⬢ Initial build completed in 1.2s.

┌─ Watching
│  Source          ./docs
│  Config          ./docmd.config.json
│  Assets          ./assets
└──────────────────────────────────────────────────────────
┌─ Development Server Running
│  Local Access    http://127.0.0.1:3000
│  Network Access  http://192.168.1.6:3000
│  Serving from    ./site
└──────────────────────────────────────────────────────────

Navigation is generated from your file structure. No config file, no frontmatter required, no framework to learn.

When you're ready to ship:

npx @docmd/core build

This outputs a highly optimized static site (SPA) ready for deployment to Vercel, Cloudflare Pages, Netlify, GitHub Pages, or any static host.

Requirements: Node.js 18+

# Install globally via npm
npm install -g @docmd/core

# Or via pnpm
pnpm add -g @docmd/core

# Run it
docmd dev    # start dev server
docmd build  # build for deployment

docker run -p 3000:3000 ghcr.io/docmd-io/docmd:0.8.7

Why docmd?

Features

Zero config, instant start

Point docmd at any Markdown folder and it runs. Navigation is built automatically from your file structure. You can write your first doc and have it live in under a minute — no boilerplate, no build pipeline to configure, no decisions to make upfront.

Tiny by default, fast everywhere

The default JavaScript payload is ~18 kb. Pages navigate as an instant SPA. The output is static HTML — SEO-optimised, with sitemap, canonical URLs, and Open Graph metadata included. Offline full-text search is built in, no cloud service required.

AI-native

docmd is built for the way documentation is read and used today:

• MCP Server — docmd mcp exposes your docs to AI agents over stdio, letting them search, read, and validate content directly.
• Context (llms.txt / llms-full.txt) — complete documentation context generated at build time, ready for any LLM.
• Agent Skills — modular instruction sets for LLMs and IDE agents (docmd-skills).
• Copy as Markdown / Copy Context — one-click buttons in the browser, optimised for pasting into AI chat.

Built to scale

• Internationalisation with multi-locale builds (per-locale search index, llms, okf, hreflang)
• Versioning for multiple doc releases (with auto-detection of the current version)
• Workspaces for monorepos and multi-project setups
• Plugin system for extending core behaviour (per-hook return-type validation, async-friendly)
• Full theming support, built-in templates, custom CSS/JS, light/dark mode

CLI

docmd dev            # local development server
docmd build          # build for deployment
docmd live           # browser-based Live Editor
docmd init           # scaffold a new docmd.config.json in the current folder
docmd stop           # stop any running `docmd dev` / `docmd live` servers
docmd doctor         # pre-flight check: config + plugin install status
docmd migrate        # migrate to docmd from Docusaurus, VitePress, MkDocs, or Starlight
docmd deploy         # generate config for Docker, NGINX, Caddy, Vercel, Netlify
docmd validate       # check all internal links
docmd mcp            # run as an MCP server over stdio
docmd add <name>     # install a plugin or template

Plugins

Core functionality is powered by a robust plugin system. The essentials are included by default, while optional plugins can be added for specific needs.

Install optional plugins:

docmd add <plugin-name>

Build your own: Plugin Development Guide

Configuration

No configuration is required to get started. Add a docmd.config.json (or .ts / .js) in your project root only when you need more control:

{
  "title": "My Project",
  "url": "https://docs.myproject.com",
  "src": "./docs",
  "out": "./dist"
}

TypeScript and JavaScript config files are supported for dynamic values.

Full reference: Configuration Overview

Project Structure

my-docs/
├── docs/                ← Your markdown files
├── assets/              ← Images and static files
├── docmd.config.json    ← Optional configuration
└── package.json

Live Editor

A browser-based editor for writing and previewing docs — no local setup required.

Try it at live.docmd.io

Programmatic API

Use docmd in Node.js scripts, CI pipelines, or custom build steps. (Supports both CommonJS and ESM).

import { build } from '@docmd/core';

await build('./docmd.config.json', { isDev: false });

Full reference: Node API

Community

• Bugs & issues → GitHub Issues
• Questions & ideas → Discussions
• Contributing → CONTRIBUTING.md
• Roadmap → GitHub Discussions

Support

• Getting the word out is the most direct way to support docmd's development. Share it on X with friends or give it a star.
• If docmd saves you time, a GitHub sponsorship goes a long way.
• Got ideas or bugs? Open an issue or PR, feel free to contribute your own plugins.

License

MIT License. See LICENSE for details.