CLI Reference

mkdnsite [directory] [options]

# Basic usage
mkdnsite ./content

# With config file
mkdnsite --config mysite.config.ts

# Mix config file and CLI overrides
mkdnsite --config mysite.config.ts --color-scheme dark --port 4000

# Force dark mode on a light-mode site
mkdnsite --config docs.config.ts --color-scheme dark

mkdnsite ./docs --static ./public

# Only serve files under docs/ and guides/
mkdnsite --include 'docs/**' --include 'guides/**'

# Exclude draft files and a private directory
mkdnsite --exclude '**/*.draft.md' --exclude 'private/**'

mkdnsite -p 8080
mkdnsite --port 4000

mkdnsite --title "My Docs" --url "https://docs.example.com"

mkdnsite ./content \
  --url "https://docs.example.com" \
  --og-image "https://docs.example.com/og-image.png" \
  --twitter-card summary_large_image \
  --twitter-site "@myproject"

mkdnsite --color-scheme dark    # always dark
mkdnsite --color-scheme light   # always light
mkdnsite --color-scheme system  # follow OS (default)

mkdnsite --accent "#7c3aed"
mkdnsite --accent "oklch(0.5 0.2 270)"

mkdnsite --font-heading '"Playfair Display", serif' \
         --font-body '"Inter", sans-serif'

mkdnsite \
  --custom-css-url "https://fonts.googleapis.com/css2?family=Inter:wght@400;600&display=swap" \
  --font-body '"Inter", sans-serif'

mkdnsite --static ./static --logo /logo.png --logo-text "My Docs"

# Quick tweak via inline CSS
mkdnsite --custom-css ".mkdn-main { max-width: 1000px; }"

# Load a custom theme file
mkdnsite --static ./static --custom-css-url /my-theme.css

# Full replacement
mkdnsite --no-builtin-css --custom-css-url /my-complete-theme.css

# Local content directory
mkdnsite mcp ./content

# GitHub repository
mkdnsite mcp --github owner/repo

# GitHub repo with specific branch and subdirectory
mkdnsite mcp --github owner/repo --github-ref v2.0 --github-path docs

# Use a config file
mkdnsite mcp --config my-docs.config.ts

{
  "mcpServers": {
    "my-docs": {
      "command": "mkdnsite",
      "args": ["mcp", "./path/to/content"]
    }
  }
}

{
  "mcpServers": {
    "mkdnsite-docs": {
      "command": "mkdnsite",
      "args": ["mcp", "--github", "mkdnsite/mkdnsite"]
    }
  }
}

# Disable MCP (e.g. public-facing site)
mkdnsite --no-mcp

# Custom endpoint path
mkdnsite --mcp-endpoint /api/mcp

# Serve a public repo from main branch
mkdnsite --github owner/repo

# Serve a specific branch and subdirectory
mkdnsite --github owner/repo --github-ref develop --github-path docs

# Use a token for private repos or to avoid rate limits
mkdnsite --github myorg/private-docs --github-token ghp_xxx

# Or set the env var (no need for --github-token)
GITHUB_TOKEN=ghp_xxx mkdnsite --github myorg/private-docs

mkdnsite --preset docs ./content   # nav + TOC + prev/next links
mkdnsite --preset blog ./posts     # page title, date, reading time, prev/next

# Manual blog setup without a preset
mkdnsite ./posts \
  --page-title \
  --page-date \
  --reading-time \
  --prev-next \
  --no-nav \
  --no-toc

mkdnsite --no-nav   # single-page or minimal sites
mkdnsite --no-toc   # disable TOC without disabling nav

# Public site where you don't want to expose raw Markdown
mkdnsite --no-negotiate --no-llms-txt

# Maximum performance / accessibility
mkdnsite --no-client-js

# Keep mermaid and copy but remove theme toggle
mkdnsite --no-theme-toggle

# Disable search (e.g. public-facing site without search UI)
mkdnsite --no-search

# Add Google Analytics
mkdnsite --ga-measurement-id G-XXXXXXXXXX

# Debug traffic classification locally
mkdnsite --traffic-analytics --traffic-console

# Enable caching with custom TTL
mkdnsite --cache --cache-max-age 600

# Cache with stale-while-revalidate for CDN
mkdnsite --cache --cache-max-age 300 --cache-swr 60 --cache-version v1.4.1

mkdnsite --renderer bun-native   # Bun only, faster but no full GFM support
mkdnsite --renderer portable     # works everywhere, full GFM support (default)

mkdnsite --help     # show all flags
mkdnsite -h

mkdnsite --version  # show version
mkdnsite -v

mkdnsite ./posts --preset blog --title "My Blog"

mkdnsite ./content \
  --static ./static \
  --logo /logo.svg \
  --logo-text "My Project" \
  --accent "#0ea5e9" \
  --title "My Project Docs"

mkdnsite ./content \
  --no-negotiate \
  --no-llms-txt \
  --title "Internal Docs"

mkdnsite ./content \
  --no-client-js \
  --color-scheme light

# Use a project-specific config
mkdnsite --config docs.config.ts

# Override color scheme for testing
mkdnsite --config docs.config.ts --color-scheme dark