Run docmd instantly in any folder with Markdown files:

npx @docmd/core dev

Starts: http://localhost:3000

That’s it.

• Navigation is generated automatically
• Pages render instantly
• Your docs are production-ready by default

Build your site:

npx @docmd/core build

npm install -g @docmd/core

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

Designed to start instantly and scale without friction.

• Automatic navigation from your files
• Zero configuration required
• Works directly with Markdown

• Static HTML generation
• SEO optimised (sitemap, canonical, redirects)
• Tiny JavaScript payload

• Internationalisation (i18n)
• Versioning
• Offline search
• PWA support
• Analytics
• AI context (llms.txt)

• Plugin support
• Custom configuration and navigation
• Theming
• Programmatic API

See the full roadmap.

Keeps your project simple.

my-docs/
├── docs/
├── assets/
├── docmd.config.js (optional)
└── package.json

A browser-based editor for writing and previewing docs instantly. No setup required.

Try it: live.docmd.io

No configuration is required to get started.

Add a config file (docmd.config.js in the project root) only when you need more control.

const { defineConfig } = require('@docmd/core');

module.exports = defineConfig({
  title: 'My Project',
  url: 'https://docs.myproject.com',
});

module.exports = defineConfig({
  // Versioning
  versions: {
    current: 'v2',
    all: [
      { id: 'v2', dir: 'docs' },
      { id: 'v1', dir: 'docs-v1' }
    ]
  },

  // Internationalisation
  i18n: {
    default: 'en',
    locales: [
      { id: 'en', label: 'English' },
      { id: 'zh', label: '中文' },
    ]
  }
});

Other common settings include src, out, navigation, plugins, and theming.

Use in scripts or CI pipelines:

const { build, buildLive } = require('@docmd/core');

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

Full configuration, plugins, and advanced usage: docs.docmd.io

Core functionality is included by default.

Everything works out of the box.

Plugins are only needed when you want to extend functionality.

Install optional plugins:

docmd plugin add <plugin-name>

Starts simple. Scales without friction.

Documentation tools should disappear.

Focus on writing, not setup.

No configuration overhead. No framework complexity. Just docs.

• Contributions are welcome. See CONTRIBUTING.md
• If you find it useful, consider sponsoring or starring the repo ⭐

MIT License. See LICENSE for details.