_ _
_| |___ ___ _____ _| |
| . | . | _| | . |
|___|___|___|_|_|_|___|
Generate professional, high-performance documentation sites directly from Markdown. Zero clutter, just content.
docmd bridges the gap between simple static site generators and heavy, framework-driven documentation tools. It transforms standard Markdown into highly optimised static HTML while delivering a seamless Single Page Application (SPA) experience.
Quick Start
Requires Node.js (v18 or higher) installed.
Deploy a beautiful, searchable documentation site in seconds. No framework knowledge or complex setup required.
1. Install docmd as a development dependency
npm install -D @docmd/core # Recommended: Install locally
npx @docmd/core init # Initialise your project configuration
npx @docmd/core dev # Start the development server
2. Global Installation (Optional)
npm install -g @docmd/core # Run docmd from anywhere on your system
3. Instant Zero-Config Execution
# Start a dev server instantly without any local configuration
npx @docmd/core dev -z
Once running, open http://localhost:3000 in your browser. Changes to your files in the docs/ folder will reflect instantly via Hot Module Replacement (HMR).
Why choose docmd?
Writing documentation should be frictionless. You shouldn’t have to manage complex JavaScript frameworks or deep configuration trees just to publish technical text. docmd is built for both humans and AI, serving as the most LLM-friendly static site generator available.
<div class=“image-gallery” style=“grid-template-columns: repeat(auto-fit, minmax(300px, 1fr));”>
docmd generates a structured context for LLMs (llms.txt and llms-full.txt), allowing AI models to ingest your entire project context perfectly in a single request.
Executing docmd dev -z automatically scans for documentation directories, extracts headings as page titles, and builds a nested, collapsible navigation tree instantly.
We serve pre-rendered HTML for maximum SEO and initial load speed. Once loaded, docmd transitions between pages as a high-performance SPA, ensuring instant content swaps without full browser reloads.
Features built-in full-text search with fuzzy matching and deep linking. The search index runs entirely in-browser, making it fully functional in offline or air-gapped environments.
Designed for all devices. Includes premium themes with native Light/Dark appearance modes, sticky versioning, and mobile-optimised sidebars out of the box.
The same engine used for static builds can run natively in the browser. Embed live documentation previews or interactive editors directly into your own web applications.
</div>
Rich Content Out of the Box
docmd extends standard Markdown with intuitive components designed for professional documentation structures.
Highlight critical information with Callouts and native Buttons.
Nest containers inside each other to create complex layouts without touching HTML or CSS.
Create professional architectural diagrams using Mermaid.js syntax directly in your Markdown files.
Automatic syntax highlighting via our custom lite-hl engine, including one-click copy buttons and multi-language support.
// docmd.config.js
import { defineConfig } from '@docmd/core';
export default defineConfig({
title: 'My Project',
layout: { spa: true }
});
Ready to build? Install docmd or see Zero-Config Mode in action.