A modular skill set for AI agents to understand and work with docmd documentation projects.
---
name: docmd-skills
description: AI agent instructions for docmd — the zero-config AI-first documentation engine. Use when working with docmd projects, configuring documentation sites, building plugins, or understanding docmd's capabilities.
when_to_use: |
Use this skill when:
- Setting up or configuring docmd documentation projects
- Working with docmd CLI commands (init, dev, build, deploy, live, validate)
- Creating or modifying docmd.config.json configuration files
- Building custom plugins for docmd
- Understanding docmd's markdown extensions and formatting
- Using docmd's Node.js or browser APIs
- Troubleshooting docmd builds or deployments
- User mentions "docmd" or asks about documentation generation
docmd-repo: https://github.com/docmd-io/docmd
skills-repo: https://github.com/docmd-io/docmd-skills
docs: https://docs.docmd.io
llms-context: https://docs.docmd.io/llms-full.txt
---
# docmd — Zero-Config AI-First Documentation Engine
docmd is a modern documentation generator designed for AI-first workflows. It features zero-configuration setup, instant builds, live browser-based editing, and native AI agent integration via MCP.
## Quick Reference
**Installation**
```bash
npm install -D @docmd/core
npx @docmd/core init
```
**Core Commands**
- `docmd init` — Scaffold new project
- `docmd dev` — Development server with hot reload (default: port 3000)
- `docmd build` — Production build to `site/` directory
- `docmd live` — Browser-based Live Editor
- `docmd validate` — Link validation for CI/CD
- `docmd mcp` — MCP server for AI agent integration
**Key Features**
- Zero-config: auto-detects `docs/`, `src/docs/`, or any `.md` folder
- Built-in search (keyword + optional semantic)
- Plugin system with lifecycle hooks
- Multi-version and i18n support
- Live Editor with in-browser builds
- AI-ready with `llms.txt` generation
## Reference Documentation
For detailed information, see the following reference files in the `references/` directory:
- **[CLI Reference](./references/cli.md)** — All commands, flags, and options
- **[Configuration](./references/config.md)** — Complete config schema with defaults
- **[Workspaces](./references/workspaces.md)** — Multi-project workspace setup
- **[Plugins](./references/plugins.md)** — Built-in plugins and configuration
- **[Plugin Development](./references/plugin-development.md)** — Hooks, lifecycle, custom plugins
- **[Formatting](./references/formatting.md)** — Containers, frontmatter, markdown extensions
- **[API Reference](./references/api.md)** — Node.js API, browser API, utilities
- **[Engines](./references/engines.md)** — Build engine architecture (JS/Rust)
- **[Migration](./references/migration.md)** — Migrate from Docusaurus, MkDocs, VitePress
- **[Validation](./references/validation.md)** — Link checking and CI/CD integration
- **[Deployment](./references/deployment.md)** — GitHub template, Actions, Docker, platforms
## AI Agent Integration
### llms.txt Context Files
- Full context: `{site_url}/llms-full.txt`
- Short context: `{site_url}/llms.txt`
- Auto-generated by the `llms` plugin at build time
### MCP Server
```bash
docmd mcp # Starts JSON-RPC 2.0 server over stdio
```
Exposes tools for:
- Building and validating documentation
- Reading/writing source files
- Managing configuration
- Live preview integration
### Recommended Workflow
1. Start with this skill to understand docmd's capabilities
2. Read specific reference files as needed for your task
3. Use `llms-full.txt` for comprehensive documentation context
4. Connect via MCP for real-time project interaction
## Common Tasks
### Create New Project
```bash
npx @docmd/core init
# Creates: docs/index.md, docmd.config.json, package.json scripts
```
### Configure Site
```json
{
"title": "My Documentation",
"url": "https://docs.example.com",
"src": "docs",
"out": "site"
}
```
### Add Plugin
```bash
docmd add search # Installs @docmd/plugin-search
```
### Build for Production
```bash
docmd build
# Outputs to site/ directory
```
### Validate Links
```bash
docmd validate --json # For CI/CD pipelines
```
## Architecture
docmd consists of several packages:
- `@docmd/core` — Main build engine (CLI + Node API)
- `@docmd/api` — URL utilities and shared helpers
- `@docmd/parser` — Markdown parsing and rendering
- `@docmd/ui` — Frontend UI components
- `@docmd/plugin-*` — Official plugins (search, git, seo, etc.)
All packages are published to npm under the `@docmd` scope.
## Support
- Documentation: https://docs.docmd.io
- GitHub: https://github.com/docmd-io/docmd
- Issues: https://github.com/docmd-io/docmd/issues