Docmd skills

Skill docmd-io/docmd-skills/skills/docmd-skills

A modular skill set for AI agents to understand and work with docmd documentation projects.

Install

npx -y skills add docmd-io/docmd-skills --skill docmd-skills

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

One thing to look at

3 stars3 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

What its author says it does

Copied from the file, not written here

Use this skill when working with a docmd site — scaffolding, configuring, building, validating, deploying, or operating one. Covers the CLI, config, themes, plugins, MCP, migration, and deployment.

SKILL.md

4.5 KB, as published. Nobody here has run it

docmd — Agent Skill (User)

Use this skill when the user wants to build, configure, or operate a docmd documentation site. It is the default install and is loaded by npx docmd-skills <dir>.

When to use this skill

Use it when the user wants to:

Scaffold a new docmd site (npx @docmd/core init)
Run the dev server, build, validate, deploy, or live-reload
Edit docmd.config.json (themes, navigation, layout, plugins, i18n, versions)
Use the docmd mcp server (search_docs, read_doc, validate_docs, get_llms_context)
Migrate from Docusaurus / MkDocs / VitePress to docmd
Pick between the JS and Rust build engines
Add a community plugin (search, Mermaid, analytics, sitemap, etc.)

Do not use it for: writing or reviewing the prose inside pages (use docmd-writer), or hacking on the docmd framework itself (use docmd-dev).

Loading rules

Load SKILL.md (this file) by default whenever the user touches a docmd project.
Load any reference file from the index below on first mention, or when the user asks for that specific surface.
If the user is writing or editing page copy (markdown body, headings, intro paragraphs, callouts for tone), switch to docmd-writer instead.
If the user is editing files inside the cloned docmd/ monorepo (packages/core/src/, packages/api/src/, etc.), switch to docmd-dev instead.

Reference index

Each row is a reference file. Load it when you need it; the CLI column shows which docmd-skills subcommand also installs that exact file.

Reference	CLI install subcommand	Use it for
`references/cli.md`	`docmd-skills` (default)	All `npx @docmd/core` subcommands: `init`, `dev`, `build`, `validate`, `live`, `deploy`, `mcp`
`references/config.md`	`docmd-skills` (default)	`docmd.config.json` schema, themes, navigation, layout, i18n, versions, plugins
`references/formatting.md`	`docmd-skills` (default)	docmd-flavoured markdown: containers, tabs, cards, grids, steps, frontmatter, Mermaid
`references/plugins.md`	`docmd-skills` (default)	Built-in and community plugins, `plugins:` config, plugin resolution order
`references/migration.md`	`docmd-skills` (default)	Migrating from Docusaurus, MkDocs, VitePress to docmd
`references/deployment.md`	`docmd-skills` (default)	Static hosting, SPA routing rewrites, `docmd deploy`, Docker, CI recipes
`references/validation.md`	`docmd-skills` (default)	`docmd validate`, frontmatter rules, link checking, MCP `validate_docs`
`references/workspaces.md`	`docmd-skills` (default)	Monorepo / multi-package doc workspaces, shared assets, cross-site nav
`references/api-user.md`	`docmd-skills` (default)	Node API surface used by consumers of `@docmd/core`, `@docmd/live`, `@docmd/ui`

Workflows

1. New project

Run npx @docmd/core init (or use pnpm create @docmd/core).
Open docmd.config.json; cross-check against references/config.md.
Add pages under docs/; follow references/formatting.md and (for prose quality) docmd-writer.
npx @docmd/core dev for live preview, then validate and build.

2. Existing project, new feature

Skim references/config.md for the relevant section.
Check references/plugins.md first — the feature may be a one-line plugin.
If the change touches page prose, hand off to docmd-writer for the body and back to this skill for config.

3. CI / deploy

references/validation.md for the gate command.
references/deployment.md for the target host (Netlify / Vercel / Nginx / Caddy / Cloudflare Pages / GitHub Pages / Docker).

Cross-skill navigation

docmd-dev — only when the user is editing the docmd/ framework monorepo.
docmd-writer — whenever the task is about writing or improving the prose in pages.