Run docmd inside any folder with Markdown files. No config file, setup, or framework knowledge required.

1. Start a dev server

npx @docmd/core dev

bunx @docmd/core dev

This opens http://localhost:3000. Your documentation is live.

<img width=“500” class=“with-border” src=“/assets/previews/terminal-npx-dev.webp”>

2. Automatic features

The engine sets up everything automatically:

1. Directory Detection: Scans for docs/, src/docs/, documentation/, content/, or any .md files in the project root.
2. Navigation Structuring: Builds a nested sidebar from your folder tree.
3. Title Resolution: Extracts page titles from the first H1 tag automatically.
4. Search Indexing: Enables built-in full-text search immediately.
5. Smart Caching: Triggers sub-200ms rebuilds instantly on file save.

No docmd.config.json is required. Add one later to customise layouts, plugins, or versions.

3. Build for production

Compile your Markdown files into a static, production-ready site.

npx @docmd/core build

bunx @docmd/core build

The compiler outputs a static site to ./site/.

Host this static output anywhere. Deploy to GitHub Pages, Vercel, Netlify, or any static host.