Skip to content

Vireo Documentation

Welcome to the official documentation for Vireo — a modern Design as a Code (DaaC) platform and compiler.

Vireo replaces manual design files with human-readable .dac source code. It treats user interface design with the same rigor as software engineering: component modularity, inheritance, layout constraint solving, and automated compilation into production targets including HTML/CSS, JSON AST, and Figma.


Documentation Overview

Explore the core sections of the Vireo platform:

SectionDescription
Getting StartedInstall Vireo CLI, initialize your workspace, and render your first design
Core ConceptsThe DaaC philosophy, file structure, and compiler architecture
Addressing & CompositionCross-file references with dot-notation (file.block.component) and ref: overrides
Expressions & VariablesDynamic design tokens with var, helper fun, and conditionals
Component ModelStructure of .dac components, nesting, and lifecycle
Properties CatalogueExhaustive reference of sizing, typography, colors, borders, and shadows
Buttons & ActionsStandard button variants (Primary, Secondary, Success, Ghost) and sizes
Badges & IndicatorsStatus badges, pills, and indicators
Containers & CardsStructural components, cards, elevation shadows, and auto-stretching
Forms & InputsForm elements, inputs, placeholders, and interactive states
Layout SystemAuto Layout (flexbox), explicit geometry, and relational constraints
RenderersTarget outputs: HTML, JSON AST, and Figma
CLI ReferenceComprehensive manual for all vireo commands and flags
Figma Plugin GuideImporting compiled designs directly into Figma canvas

Why Design as a Code?

Traditional design systems suffer from friction between design canvases and engineering repositories:

  1. Design Drift: Mockups go stale while code evolves.
  2. AI Agent Inaccessibility: LLMs and autonomous coding agents cannot reliably read or inspect binary Figma files.
  3. Lack of Version Control: Binary canvas files do not support standard git branching, reviews, or automated CI testing.

With Vireo, your design system is:

  • 100% Machine-Readable: AI coding agents inspect, generate, and refactor .dac files natively.
  • Git-Native: Designs live alongside your codebase with git diffs, pull requests, and automated validation.
  • Multi-Target: Compile a single .dac specification into live web prototypes, Figma canvas frames, and JSON schemas.

Released under the MIT License.