sitemd#

Build websites from Markdown with MCP tools. Works as an OpenClaw skill or plugin — your agent can create, manage, and deploy websites through conversation.

First Steps#

1. If no binary ( sitemd/sitemd does not exist) — run ./sitemd/install to download it
2. Call sitemd_status to understand the project state
3. If fresh project — read files in pages/, then create pages with sitemd_pages_create
4. Call sitemd_site_context with a content type to get site identity, conventions, and existing pages
5. Validate with sitemd_content_validate
6. Deploy with sitemd_deploy

Authentication#

sitemd uses email magic links. When your owner needs to log in:

1. Call sitemd_auth_login — returns a browser URL
2. Send the URL to your owner as a message (WhatsApp, Telegram, Discord, etc.)
3. They tap the link and complete login in their browser
4. Call sitemd_auth_poll every few seconds until it returns approved

For automated deploys, use sitemd_auth_api_key to create a long-lived key, then set SITEMD_TOKEN in your environment.

Project Structure#

• sitemd — Compiled binary (run ./sitemd/sitemd launch)
• install — Bootstrap script (run ./sitemd/install to download binary)
• pages/ — Markdown content files with YAML frontmatter
• settings/ — Site configuration (YAML frontmatter in .md files)
• theme/ — CSS and HTML templates
• media/ — Images and assets
• site/ — Built output

MCP Tools#

ToolPurposesitemd_statusProject state overviewsitemd_pages_createCreate new pages (writes file + nav + groups)sitemd_pages_create_batchCreate multiple pages in one callsitemd_pages_deleteDelete a page (cleans up nav + groups)sitemd_groups_add_pagesAdd pages to group sidebarsitemd_site_contextSite identity, pages, conventionssitemd_content_validateValidate content qualitysitemd_seo_auditSEO health check with scored reportsitemd_initInitialize project from templatesitemd_buildBuild without deployingsitemd_deployBuild and deploy sitesitemd_activateActivate site (permanent)sitemd_cloneClone an existing websitesitemd_config_setSet backend config (routes secrets vs non-secrets)sitemd_auth_loginStart login flowsitemd_auth_pollPoll for login completionsitemd_auth_statusCheck auth state and license infositemd_auth_api_keyCreate API key for automationsitemd_auth_setupEnable user authenticationsitemd_update_checkCheck for updatessitemd_update_applyApply updates

Read pages, settings, and groups files directly — no MCP tool needed for reads.

Settings Files#

All configuration is in settings/*.md frontmatter:

FileControlsmeta.mdSite title, brand name, description, URLheader.mdNavigation items, brand display, searchfooter.mdFooter links, copyright, socialgroups.mdPage groups for sidebars and dropdownstheme.mdColors, fonts, layout, light/dark/paper modesbuild.mdDev server port, output directorydeploy.mdDomain, deploy targetseo.mdOG images, sitemaps, structured data

Content Types#

sitemd supports structured content generation. Call sitemd_site_context with a type to get conventions and existing pages. The syntax reference is below.

• page — General pages. Second person, present tense, lead with reader value.
• docs — Documentation. Imperative mood, show what to type, code blocks, tables.
• blog — Blog posts. Opinionated, date line, 400-1200 words.
• changelog — Release notes. Terse, Added/Changed/Fixed/Removed sections.
• roadmap — Product roadmap. Shipped/In Progress/Planned sections.

Markdown Extensions#

Beyond standard markdown, sitemd supports rich components. The syntax reference is below.

• button: Label: /slug — styled buttons. Modifiers: +outline, +big, +newtab, +color:red
• card: Title / card-text: / card-image: / card-link: — responsive card grids
• embed: URL — auto-detects YouTube, Vimeo, Spotify, X, CodePen, etc.
• gallery: with indented ![alt](url) — image grid with lightbox
• image-row: with indented ![alt](url) — equal-height image row
• ![alt](url +width:N +circle +bw +expand) — image modifiers
• [text]{tooltip content} — inline tooltips
• modal: id with indented content, trigger via [link](#modal:id) — modal dialogs
• {#custom-id} — inline anchors
• [text](url+newtab) — link modifiers
• form: with indented YAML — forms
• gated: type1, type2 ... /gated — gated sections
• data: source / data-display: cards|list|table — dynamic data