Reference

Technical reference documentation for StyleScribe. Use this section to look up specific syntax, options, and APIs.

Reference Guides

Annotations

JSDoc-style component documentation syntax

CLI Commands

Complete reference for all 13 CLI commands

Configuration

.stylescriberc.json options

Design Tokens

W3C DTCG format and 46 token functions

Icons

CSS mask-image icons from npm packages

What's in Reference?

Reference documentation is information-oriented — it describes how things work without explaining when to use them. It's organized for quick lookup.

Document	Contains
Annotations	All `@annotation` tags, syntax, examples
CLI Commands	All 13 commands with options and examples
Configuration	Every `.stylescriberc.json` option
Design Tokens	W3C DTCG format, 46 functions, types
Icons	Supported packages, token format, CLI tools

Quick Lookup

Common Annotations

@title        // Display name (required)
@description  // Component purpose (required)
@group        // Navigation category (required)
@variations   // Modifier classes
@elements     // BEM child elements
@examples     // Code samples
@dependencies // Required components

Key CLI Commands

stylescribe init         # Create new project
stylescribe dev          # Development server
stylescribe build        # Compile CSS
stylescribe docs         # Generate static site
stylescribe tokens       # Token operations

Config Quick Reference

{
  "classPrefix": "ds-",
  "source": "./sass/components",
  "output": "./dist",
  "tokens": { "input": "./tokens/design-tokens.json" }
}