Skip to content

Docmd

Documentation compiler for humans and machines. One Markdown source to website, search, AI context, and knowledge formats together.

Install

$npx @docmd/core dev
Claude Code
claude mcp add docmd -- npx @docmd/core dev
Cursor / Claude Desktop (mcp.json)
{
  "mcpServers": {
    "docmd": {
      "command": "npx",
      "args": [
        "@docmd/core",
        "dev"
      ]
    }
  }
}

Install command taken from the project's README or registry entry. Always review code before running it.

EN  |  DE  |  中文  |  ES  |  日本語  |  FR  |  RU  |  TR

<b>Documentation for humans and machines.</b>
One Markdown source → website, search, AI context, agents, and knowledge formats.










Website &nbsp;·&nbsp;
Documentation &nbsp;·&nbsp;
Cloud Relay &nbsp;·&nbsp;
Live Editor &nbsp;·&nbsp;
Agent Skills &nbsp;·&nbsp;
Issues

Quick Start

Point docmd at a folder of Markdown files:

npx @docmd/core dev

Open http://localhost:3000.

That's it. Navigation is generated from your file structure. No config file, frontmatter, or framework required.

When you're ready to deploy:

npx @docmd/core build

docmd generates a static site that can be deployed to Vercel, Cloudflare Pages, Netlify, GitHub Pages, S3, NGINX, Caddy, or any other static host.

Requires Node.js 20+.

Global installation and Docker

Install globally:

npm install -g @docmd/core

# or
pnpm add -g @docmd/core

Then:

docmd dev
docmd build

Or run with Docker:

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

Pin the Docker image to a specific release for reproducible production builds.

One Source. Every Output.

docmd is an open source documentation compiler.

Instead of treating your Markdown as input for a website alone, docmd compiles the same source into outputs for readers, search engines, LLMs, coding agents, and knowledge systems.

Markdown
   │
   ▼
 docmd
   │
   ├── → Static documentation site
   ├── → Offline search index
   ├── → llms.txt / llms-full.txt
   ├── → Open Knowledge Format (OKF)
   ├── → Sitemap + SEO metadata
   ├── → robots.txt + Open Graph
   ├── → MCP interface for AI agents
   └── → AI Assistant context

One source tree. One build pipeline. No separate documentation and AI knowledge stacks to maintain.

Why docmd?

Documentation increasingly has more than one reader.

People need a fast, navigable website. Search engines need structured metadata. LLMs need clean context. Coding agents need tools and protocols. RAG systems need structured knowledge.

docmd builds these together while keeping Markdown at the centre.

See the complete comparison with Docusaurus, Mintlify and other documentation tools →

Features

Zero config, instant start

Point docmd at any Markdown folder and it runs. Navigation is generated automatically from your file structure — no boilerplate, frontmatter, or build pipeline required to get started.

Lightweight by default, fast everywhere

docmd generates static HTML with minimal vanilla JavaScript and fast SPA-style navigation. Offline full-text search, sitemap, canonical URLs, Open Graph metadata, and other essentials are built into the output.

AI & agent-ready

docmd treats machine-readable documentation as part of the build, not a separate publishing workflow.

Similar plugs

The agent harness performance optimization system. Skills, instincts, memory, security, and research-first development for Claude Code, Codex, Opencode, Cursor and beyond.

Java 面试 & 后端通用面试指南,覆盖计算机基础、数据库、分布式、高并发、系统设计与 AI 应用开发

Build Agentic workflows, RAG pipelines, with rich AI model and tool support on one collaborative workspace. Deploy on cloud, VPC, or self-hosted, so teams move from prototype…

Give your AI agent eyes to see the entire internet. Read & search Twitter, Reddit, YouTube, GitHub, Bilibili, XiaoHongShu — one CLI, zero API fees.