sitemd.cc

Cursor

sitemd ships as a Cursor plugin with rules, skills, and CLI commands. Install the plugin or clone the repo and Cursor's agent gets the sitemd skill, CLI commands, and auto-attaching rules that surface the right context when you edit pages or settings.

Install

npx @sitemd-cc/sitemd init my-site
cd my-site
cursor .

This scaffolds a full sitemd project with .cursor-plugin/, .cursor/rules/, and .cursor/skills/ already wired. sitemd installs as an npm package — no separate install step. Open the project in Cursor and the rules and skills are active immediately.

Option 2: Cursor Marketplace

Search for sitemd in the Cursor Marketplace or run inside an existing sitemd project:

/add-plugin sitemd

This installs the rules and skills automatically. The plugin alone does not install sitemd — it expects you to already have a sitemd project on disk. Use Option 1 above for a fresh start.

Option 3: Clone from GitHub

git clone https://github.com/sitemd-cc/sitemd.git my-site
cd my-site
npm install

The repo includes .cursor-plugin/, .cursor/rules/, and .cursor/skills/ at the root. Cursor picks them up automatically.

How sitemd integrates with Cursor

Cursor's plugin system has five extension primitives. sitemd uses two of them:

Primitive What sitemd ships Purpose
Rules .mdc files in .cursor/rules/ Context that loads automatically based on what you're editing
Skills Skill directories in .cursor/skills/ Task workflows the agent discovers and runs on demand

Rules are always-on or file-pattern-triggered context. Skills are dynamic — the agent reads their descriptions and loads them when the task matches. The agent runs sitemd CLI commands to interact with the build system.

Rules

Rules are .mdc files with YAML frontmatter that control when Cursor loads them into the agent's context. sitemd ships three:

sitemd-project (always on)

---
description: sitemd project structure, first steps, and CLI command reference
alwaysApply: true
---

Loaded on every conversation. Gives the agent the project layout, first-steps workflow, and a complete CLI command reference table. This is the baseline context — the agent always knows what sitemd is and what commands it has.

sitemd-pages (auto-attaches on page files)

---
description: sitemd page format, markdown extensions, and content writing conventions
globs: pages/**/*.md, sitemd/pages/**/*.md
alwaysApply: false
---

Loaded only when you open or reference a file in pages/. Contains the full page format (frontmatter fields, slug conventions), all markdown extensions (buttons, cards, embeds, galleries, forms, modals), content generation conventions by type (docs, blog, changelog, roadmap), and the groups system.

This is the largest rule (~160 lines) but it only loads when relevant — so it doesn't consume context on non-content tasks.

sitemd-settings (auto-attaches on settings files)

---
description: sitemd settings format and available configuration keys
globs: settings/**/*.md, sitemd/settings/**/*.md
alwaysApply: false
---

Loaded when you edit any file in settings/. Contains the settings format (YAML frontmatter, inline comments, no markdown body), a table of all 14 settings files with what each controls, and how to read settings/_schema to discover valid keys.

Skills

sitemd ships the sitemd skill in .cursor/skills/. The SKILL.md file has a description frontmatter field that Cursor reads to decide when to offer the skill. Type the skill name in chat to run it.

Skill Usage What it does
/write /write [type] [topic] Generate content (page, docs, blog, changelog, roadmap)
/launch /launch [demo|scratch] Start the dev server with live build sync
/deploy /deploy Build and deploy to your configured hosting target
/kickstart /kickstart [description] Generate a complete first-draft site from one prompt
/clone /clone [url] Scrape and import an existing website
/seo /seo [scope] Run an SEO health check with scored report
/site /site Show project status and available actions
/import /import [file] Import a raw markdown file as a formatted page
/og-image /og-image Generate a branded social share image
/reload /reload Hot-reload the dev server without restart
/shutdown /shutdown Stop all running dev servers
/feedback /feedback [type] [title] Submit a bug report or feature request

This is the same skill available in Claude Code and other agents. The SKILL.md format is cross-agent compatible.

Available CLI commands

sitemd exposes a full suite of commands through the CLI. Here are the ones you'll use most:

Command What it does
sitemd status Check project state, pages, auth, and config
sitemd pages create Create a new page with frontmatter and content
sitemd status --json Get writing brief, site voice, and syntax reference
sitemd validate Check page quality and fix issues
sitemd deploy Build and deploy to your hosting target
sitemd clone Scrape an existing website into editable markdown
sitemd seo Comprehensive SEO health check with scored report
sitemd config set Set deploy credentials, email keys, analytics IDs

For the full command reference, see CLI.

Build a site from Cursor

Once the plugin is installed, tell the agent what you want:

"Build me a documentation site for my API"

The agent runs sitemd status, creates pages with sitemd pages create, validates with sitemd validate, and deploys with sitemd deploy. The rules auto-attach the right syntax reference as pages are created.

You can also work incrementally:

"Add a blog post about our v2 release"

"Update the pricing page — we raised the starter plan to $29"

"Run an SEO audit and fix the issues"

The agent handles the CLI commands. You review the results in the dev server preview.

Authentication

sitemd uses 6-digit email verification codes for login. Run sitemd auth login and the agent walks you through authentication. For automated deploys, create an API key with sitemd auth api-key and store the resulting SITEMD_TOKEN in your environment.

See Authentication for the full flow.