The minimalist, zero-config documentation generator.
- Zero Config: Works out of the box with sensible defaults.
- Fast: Generates pure static HTML. No heavy JS frameworks.
- AI-Ready: Automatically generates
llms.txtfor AI agents (ChatGPT, Claude, Cursor). - Smart Search: Built-in, privacy-friendly full-text search.
- Isomorphic: Runs in Node.js (CLI) or directly in the browser.
- Rich Content: Native support for Tabs, Steps, Callouts, and Mermaid diagrams.
- Theming: Beautiful light/dark modes and multiple pre-built themes.
npm install -g @docmd/coreThe Command Line Interface is the primary way to interact with docmd.
docmd init # Initialize a new project with V2 config
docmd dev # Start a local development server with hot-reload
docmd build # Generate a production-ready static site in ./site
docmd live # Launch the browser-based Live Editor locally
docmd migrate # Automatically upgrade legacy configs to latest structuresdocmd exports its core engine, allowing you to build documentation programmatically within your own Node.js scripts or build tools.
const { build, buildLive } = require('@docmd/core');
// Trigger a standard documentation build
await build('./docmd.config.js', {
isDev: false,
preserve: true
});
// Trigger a Live Editor bundle build
await buildLive(); docmd features a modular architecture that allows the core engine to run client-side.
Running docmd live builds a standalone web application where you can write Markdown and see the preview instantly without any server-side processing. You can embed the generated docmd-live.js bundle to add Markdown capabilities to your own applications.
docmd keeps it simple. Your content lives in docs/, your config in docmd.config.js.
my-docs/
├── docs/ # Your Markdown files
│ ├── index.md # Homepage
│ └── guide.md # Content page
├── assets/ # Images and custom CSS
├── docmd.config.js # Configuration
└── package.jsonCustomize your site in seconds via docmd.config.js:
module.exports = {
siteTitle: 'My Project',
siteUrl: 'https://mysite.com',
srcDir: 'docs',
outputDir: 'site',
// V2 Layout Architecture
layout: {
spa: true, // Enable seamless page transitions
header: { enabled: true },
sidebar: { collapsible: true },
// Unified Options Menu
optionsMenu: {
position: 'header', // 'header' or 'sidebar-bottom'
components: {
search: true,
themeSwitch: true,
sponsor: 'https://github.com/sponsors/me'
}
},
// Multi-column Footer
footer: {
style: 'complete',
copyright: '© 2026 My Project',
columns: [
{
title: 'Resources',
links: [{ text: 'Guide', url: '/guide' }]
}
]
}
},
// Theme Settings
theme: {
name: 'sky',
defaultMode: 'system'
},
// Plugins
plugins: {
seo: { /* ... */ },
sitemap: { /* ... */ }
}
}| Feature | docmd | Docusaurus | MkDocs | Mintlify |
|---|---|---|---|---|
| Language | Node.js | React.js | Python | Proprietary |
| Navigation | Instant SPA | React SPA | Page Reloads | Hosted SPA |
| Output | Static HTML | React Hydration | Static HTML | Hosted |
| JS Payload | Tiny (< 20kb) | Heavy (> 200kb) | Minimal | Medium |
| Search | Built-in (Offline) | Algolia (Cloud) | Built-in (Lunr) | Built-in (Cloud) |
| Setup | ~1 min | ~15 mins | ~10 mins | Instant |
| Cost | Free OSS | Free OSS | Free OSS | Freemium |
- Contributing: We welcome PRs! See CONTRIBUTING.md.
- Support: If you find
docmduseful, please consider sponsoring the project or giving it a star ⭐.
Distributed under the MIT License. See LICENSE for more information.
{ github.com/mgks }

