update README
This commit is contained in:
@@ -41,43 +41,13 @@ It's just a markdown file. No Figma exports, no JSON schemas, no special tooling
|
||||
|
||||
**This repo provides ready-to-use DESIGN.md files** extracted from real websites.
|
||||
|
||||
|
||||
|
||||
## What's Inside Each DESIGN.md
|
||||
|
||||
Every file follows the [Stitch DESIGN.md format](https://stitch.withgoogle.com/docs/design-md/format/) with extended sections:
|
||||
|
||||
| # | Section | What it captures |
|
||||
|---|---------|-----------------|
|
||||
| 1 | Visual Theme & Atmosphere | Mood, density, design philosophy |
|
||||
| 2 | Color Palette & Roles | Semantic name + hex + functional role |
|
||||
| 3 | Typography Rules | Font families, full hierarchy table |
|
||||
| 4 | Component Stylings | Buttons, cards, inputs, navigation with states |
|
||||
| 5 | Layout Principles | Spacing scale, grid, whitespace philosophy |
|
||||
| 6 | Depth & Elevation | Shadow system, surface hierarchy |
|
||||
| 7 | Do's and Don'ts | Design guardrails and anti-patterns |
|
||||
| 8 | Responsive Behavior | Breakpoints, touch targets, collapsing strategy |
|
||||
| 9 | Agent Prompt Guide | Quick color reference, ready-to-use prompts |
|
||||
|
||||
Each site includes:
|
||||
|
||||
| File | Purpose |
|
||||
|------|---------|
|
||||
| `DESIGN.md` | The design system (what agents read) |
|
||||
| `preview.html` | Visual catalog showing color swatches, type scale, buttons, cards |
|
||||
| `preview-dark.html` | Same catalog with dark surfaces |
|
||||
|
||||
### How to Use
|
||||
|
||||
|
||||
1. Copy a site's `DESIGN.md` into your project root
|
||||
2. Tell your AI agent to use it.
|
||||
|
||||
|
||||
## Request a DESIGN.md
|
||||
|
||||
You can [request a DESIGN.md](https://getdesign.md/request) for specific website, including private requests delivered exclusively to you.
|
||||
You can [request a DESIGN.md](https://getdesign.md/request) for specific website, including private requests delivered exclusively to you.
|
||||
|
||||
## Sponsors ❤️
|
||||
|
||||
[Become a Sponsor](https://github.com/sponsors/VoltAgent/sponsorships?tier_id=605140) [1M+ view] — your logo here and get listed on [getdesign.md](https://getdesign.md/)
|
||||
|
||||
## Collection
|
||||
|
||||
@@ -161,6 +131,36 @@ You can [request a DESIGN.md](https://getdesign.md/request) for specific website
|
||||
- [**Tesla**](https://getdesign.md/tesla/design-md) - Electric vehicles. Radical subtraction, cinematic full-viewport photography, Universal Sans
|
||||
|
||||
|
||||
## What's Inside Each DESIGN.md
|
||||
|
||||
Every file follows the [Stitch DESIGN.md format](https://stitch.withgoogle.com/docs/design-md/format/) with extended sections:
|
||||
|
||||
| # | Section | What it captures |
|
||||
|---|---------|-----------------|
|
||||
| 1 | Visual Theme & Atmosphere | Mood, density, design philosophy |
|
||||
| 2 | Color Palette & Roles | Semantic name + hex + functional role |
|
||||
| 3 | Typography Rules | Font families, full hierarchy table |
|
||||
| 4 | Component Stylings | Buttons, cards, inputs, navigation with states |
|
||||
| 5 | Layout Principles | Spacing scale, grid, whitespace philosophy |
|
||||
| 6 | Depth & Elevation | Shadow system, surface hierarchy |
|
||||
| 7 | Do's and Don'ts | Design guardrails and anti-patterns |
|
||||
| 8 | Responsive Behavior | Breakpoints, touch targets, collapsing strategy |
|
||||
| 9 | Agent Prompt Guide | Quick color reference, ready-to-use prompts |
|
||||
|
||||
Each site includes:
|
||||
|
||||
| File | Purpose |
|
||||
|------|---------|
|
||||
| `DESIGN.md` | The design system (what agents read) |
|
||||
| `preview.html` | Visual catalog showing color swatches, type scale, buttons, cards |
|
||||
| `preview-dark.html` | Same catalog with dark surfaces |
|
||||
|
||||
### How to Use
|
||||
|
||||
|
||||
1. Copy a site's `DESIGN.md` into your project root
|
||||
2. Tell your AI agent to use it.
|
||||
|
||||
|
||||
## Contributing
|
||||
|
||||
|
||||
Reference in New Issue
Block a user