markdown-ui-dsl

Markdown UI DSL for AI Agents

The Markdown UI DSL is a lightweight, text-based wireframing schema that streamlines the design process for AI coding agents and enhances Spec-Driven Development (SDD). This standard provides a structured approach to creating UI specifications, minimizing issues associated with visual wireframes and natural language prompts.

The Problem

Traditional visual tools like Figma and PNGs are often complex, heavy on tokens, vulnerable to AI hallucination, and challenging to version control. Additionally, natural language prompts that lack a defined structure can result in inconsistent UI generation.

The Solution

This project addresses these challenges by offering a strict Markdown-based Intermediate Representation (IR). It allows product managers to produce readable low-fidelity specifications with ease, while AI agents can accurately parse these specifications to generate UI code in various frameworks such as React, Vue, or HTML.

Key Features

• Spec Generation: Quickly create .ui.md files in your designated folder for any new UI requirements, ensuring that designers and developers can collaborate effortlessly.
• Iterative Synchronization: Make alterations to UI specifications without modifying generated code directly. The AI automatically updates both the UI spec and targeted code component upon request.
• Design Theming: Structure and style are clearly separated, allowing custom design systems to be applied consistently across all components generated. A separate design-system.md file can enforce branding and styling rules throughout the project.

Quick Syntax Reference

• Layouts: Use ||| COLUMN ||| for vertical stacking and === ROW === for horizontal alignment.
• Components: Easily define buttons with [ Button Name ](https://github.com/MegaByteMark/markdown-ui-dsl/blob/main/#action) and implement input fields via [ text: Placeholder content ].
• Theming: Utilize YAML frontmatter to specify frameworks and design themes that govern the styling of components generated by AI agents.

Workflow Overview

1. Create Specs: Generate UI specifications in the wireframes/ folder.
2. Review and Edit: Allow team members to provide feedback and make necessary adjustments.
3. Generate Code: Prompt AI agents to convert specifications into functional components.
4. Update Specifications: Instruct AI agents to amend specs seamlessly without code disruption.

This Markdown UI DSL not only enhances the communication between product managers and developers but serves as a promising solution for efficient UI design processes catered to the capabilities of AI coding agents.