Guides

Task-focused guides for creating and customizing StyleScribe documentation.

Foundation

Content Types

Customization

Quick Reference

Core Workflow

# Initialize project
stylescribe init my-project

# Development with hot reload
stylescribe dev

# Create components
stylescribe create-component button --group="Actions"

# Generate static site
stylescribe docs

Token Management

# Validate tokens
stylescribe tokens validate

# Export to CSS
stylescribe tokens export --format=css

# Add a new theme
stylescribe add-theme dark --file=./tokens/dark.json --mode=dark

Icon Management

# List installed icon packages
stylescribe icons list

# Search for icons
stylescribe icons search -q "trash"

# Get icon token path
stylescribe icons path -p bootstrap-icons -i trash

Screenshots

# Generate all screenshots (requires Playwright)
stylescribe screenshots

# Generate specific types
stylescribe screenshots --type=components
stylescribe screenshots --type=docs

# Force regenerate all
stylescribe screenshots --force

Screenshots appear as thumbnails in search results. Run stylescribe docs first, then stylescribe screenshots.

Looking for Reference Docs?

Technical reference documentation is in the Reference section:

• Annotations — All annotation syntax
• CLI Commands — All 13 commands
• Configuration — All config options
• Design Tokens — Token format & 46 functions
• Icons — Icon system reference