oxycode-skills 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +143 -0
- package/index.js +17 -0
- package/package.json +49 -0
- package/skills/anti-slop/README.md +106 -0
- package/skills/anti-slop/SKILL.md +311 -0
- package/skills/anti-slop/examples/before-after.md +380 -0
- package/skills/anti-slop/references/quality-rubric.md +313 -0
- package/skills/anti-slop/references/slop-patterns.md +433 -0
- package/skills/component-architect/README.md +186 -0
- package/skills/component-architect/SKILL.md +644 -0
- package/skills/component-architect/examples/component-patterns.md +569 -0
- package/skills/component-architect/references/atomic-design.md +516 -0
- package/skills/design-audit/README.md +114 -0
- package/skills/design-audit/SKILL.md +305 -0
- package/skills/design-audit/examples/audit-report.md +424 -0
- package/skills/design-audit/references/scoring-rubric.md +498 -0
- package/skills/design-md/README.md +106 -0
- package/skills/design-md/SKILL.md +262 -0
- package/skills/design-md/examples/bad-design.md +195 -0
- package/skills/design-md/examples/good-design.md +250 -0
- package/skills/design-md/references/design-md-spec.md +267 -0
- package/skills/design-md/scripts/validate.sh +134 -0
- package/skills/ui-builder/README.md +169 -0
- package/skills/ui-builder/SKILL.md +357 -0
- package/skills/ui-builder/examples/dashboard.md +323 -0
- package/skills/ui-builder/examples/landing-page.md +396 -0
- package/skills/ui-builder/references/component-patterns.md +396 -0
- package/skills/ui-builder/references/layout-system.md +423 -0
- package/skills/ui-builder/references/polish-checklist.md +221 -0
|
@@ -0,0 +1,498 @@
|
|
|
1
|
+
# Design Audit Scoring Rubric
|
|
2
|
+
|
|
3
|
+
## Overview
|
|
4
|
+
|
|
5
|
+
This rubric provides detailed criteria for scoring UI code across 10 dimensions. Each dimension is scored 0-10, for a total of 100 points.
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## Dimension 1: Color System (10 points)
|
|
10
|
+
|
|
11
|
+
### 10/10: Excellent
|
|
12
|
+
- Uses design tokens exclusively
|
|
13
|
+
- Proper color hierarchy (primary, secondary, neutral)
|
|
14
|
+
- Semantic colors defined (success, warning, error)
|
|
15
|
+
- Good contrast ratios (4.5:1 for text)
|
|
16
|
+
- No hardcoded colors
|
|
17
|
+
- Dark/light theme support
|
|
18
|
+
|
|
19
|
+
### 8-9/10: Good
|
|
20
|
+
- Mostly uses design tokens
|
|
21
|
+
- Minor inconsistencies
|
|
22
|
+
- Good contrast
|
|
23
|
+
- Mostly semantic colors
|
|
24
|
+
|
|
25
|
+
### 6-7/10: Average
|
|
26
|
+
- Some hardcoded colors
|
|
27
|
+
- Inconsistent hierarchy
|
|
28
|
+
- Some contrast issues
|
|
29
|
+
- Missing semantic colors
|
|
30
|
+
|
|
31
|
+
### 4-5/10: Poor
|
|
32
|
+
- Many hardcoded colors
|
|
33
|
+
- Poor hierarchy
|
|
34
|
+
- Many contrast issues
|
|
35
|
+
- No semantic colors
|
|
36
|
+
|
|
37
|
+
### 0-3/10: Terrible
|
|
38
|
+
- All hardcoded colors
|
|
39
|
+
- No hierarchy
|
|
40
|
+
- Poor contrast
|
|
41
|
+
- Random colors
|
|
42
|
+
|
|
43
|
+
### Detection Checklist
|
|
44
|
+
```
|
|
45
|
+
✅ Uses design tokens (no hardcoded values)
|
|
46
|
+
✅ Proper color hierarchy
|
|
47
|
+
✅ Semantic colors defined
|
|
48
|
+
✅ Good contrast ratios
|
|
49
|
+
✅ No random colors
|
|
50
|
+
✅ Dark/light theme support
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
---
|
|
54
|
+
|
|
55
|
+
## Dimension 2: Typography (10 points)
|
|
56
|
+
|
|
57
|
+
### 10/10: Excellent
|
|
58
|
+
- Consistent font family
|
|
59
|
+
- Proper type scale (display, heading, body)
|
|
60
|
+
- Correct font weights
|
|
61
|
+
- Readable line heights (1.5 for body)
|
|
62
|
+
- No orphan headings
|
|
63
|
+
- Responsive typography
|
|
64
|
+
|
|
65
|
+
### 8-9/10: Good
|
|
66
|
+
- Mostly consistent
|
|
67
|
+
- Minor issues
|
|
68
|
+
- Good readability
|
|
69
|
+
- Mostly proper weights
|
|
70
|
+
|
|
71
|
+
### 6-7/10: Average
|
|
72
|
+
- Some inconsistencies
|
|
73
|
+
- Some readability issues
|
|
74
|
+
- Inconsistent weights
|
|
75
|
+
|
|
76
|
+
### 4-5/10: Poor
|
|
77
|
+
- Many inconsistencies
|
|
78
|
+
- Poor readability
|
|
79
|
+
- Random weights
|
|
80
|
+
|
|
81
|
+
### 0-3/10: Terrible
|
|
82
|
+
- No consistent font
|
|
83
|
+
- No type scale
|
|
84
|
+
- Poor readability
|
|
85
|
+
|
|
86
|
+
### Detection Checklist
|
|
87
|
+
```
|
|
88
|
+
✅ Consistent font family
|
|
89
|
+
✅ Proper type scale
|
|
90
|
+
✅ Correct font weights
|
|
91
|
+
✅ Readable line heights
|
|
92
|
+
✅ No orphan headings
|
|
93
|
+
✅ Responsive typography
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
---
|
|
97
|
+
|
|
98
|
+
## Dimension 3: Spacing (10 points)
|
|
99
|
+
|
|
100
|
+
### 10/10: Excellent
|
|
101
|
+
- Consistent spacing scale (4, 8, 16, 24, 32)
|
|
102
|
+
- Proper padding/margins
|
|
103
|
+
- Visual rhythm maintained
|
|
104
|
+
- No cramped elements
|
|
105
|
+
- No excessive whitespace
|
|
106
|
+
- Responsive spacing
|
|
107
|
+
|
|
108
|
+
### 8-9/10: Good
|
|
109
|
+
- Mostly consistent
|
|
110
|
+
- Minor issues
|
|
111
|
+
- Good rhythm
|
|
112
|
+
- Mostly proper
|
|
113
|
+
|
|
114
|
+
### 6-7/10: Average
|
|
115
|
+
- Some inconsistencies
|
|
116
|
+
- Some rhythm issues
|
|
117
|
+
- Inconsistent spacing
|
|
118
|
+
|
|
119
|
+
### 4-5/10: Poor
|
|
120
|
+
- Many inconsistencies
|
|
121
|
+
- Poor rhythm
|
|
122
|
+
- Random spacing
|
|
123
|
+
|
|
124
|
+
### 0-3/10: Terrible
|
|
125
|
+
- No spacing system
|
|
126
|
+
- No rhythm
|
|
127
|
+
- Random values
|
|
128
|
+
|
|
129
|
+
### Detection Checklist
|
|
130
|
+
```
|
|
131
|
+
✅ Consistent spacing scale
|
|
132
|
+
✅ Proper padding/margins
|
|
133
|
+
✅ Visual rhythm maintained
|
|
134
|
+
✅ No cramped elements
|
|
135
|
+
✅ No excessive whitespace
|
|
136
|
+
✅ Responsive spacing
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
---
|
|
140
|
+
|
|
141
|
+
## Dimension 4: Layout (10 points)
|
|
142
|
+
|
|
143
|
+
### 10/10: Excellent
|
|
144
|
+
- Proper grid/flex usage
|
|
145
|
+
- Responsive design (mobile-first)
|
|
146
|
+
- No overflow issues
|
|
147
|
+
- Clean alignment
|
|
148
|
+
- Consistent gutters
|
|
149
|
+
- Proper container widths
|
|
150
|
+
|
|
151
|
+
### 8-9/10: Good
|
|
152
|
+
- Mostly proper
|
|
153
|
+
- Minor issues
|
|
154
|
+
- Mostly responsive
|
|
155
|
+
- Good alignment
|
|
156
|
+
|
|
157
|
+
### 6-7/10: Average
|
|
158
|
+
- Some layout problems
|
|
159
|
+
- Some responsive issues
|
|
160
|
+
- Some alignment issues
|
|
161
|
+
|
|
162
|
+
### 4-5/10: Poor
|
|
163
|
+
- Many layout problems
|
|
164
|
+
- Poor responsive
|
|
165
|
+
- Poor alignment
|
|
166
|
+
|
|
167
|
+
### 0-3/10: Terrible
|
|
168
|
+
- Broken layout
|
|
169
|
+
- Not responsive
|
|
170
|
+
- No alignment
|
|
171
|
+
|
|
172
|
+
### Detection Checklist
|
|
173
|
+
```
|
|
174
|
+
✅ Proper grid/flex usage
|
|
175
|
+
✅ Responsive design
|
|
176
|
+
✅ No overflow issues
|
|
177
|
+
✅ Clean alignment
|
|
178
|
+
✅ Consistent gutters
|
|
179
|
+
✅ Proper container widths
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
---
|
|
183
|
+
|
|
184
|
+
## Dimension 5: Components (10 points)
|
|
185
|
+
|
|
186
|
+
### 10/10: Excellent
|
|
187
|
+
- Consistent styling
|
|
188
|
+
- Proper states (hover, focus, active, disabled)
|
|
189
|
+
- Accessible
|
|
190
|
+
- Reusable
|
|
191
|
+
- Well-structured
|
|
192
|
+
- Proper variants
|
|
193
|
+
|
|
194
|
+
### 8-9/10: Good
|
|
195
|
+
- Mostly consistent
|
|
196
|
+
- Most states present
|
|
197
|
+
- Mostly accessible
|
|
198
|
+
- Mostly reusable
|
|
199
|
+
|
|
200
|
+
### 6-7/10: Average
|
|
201
|
+
- Some inconsistencies
|
|
202
|
+
- Some missing states
|
|
203
|
+
- Some accessibility issues
|
|
204
|
+
|
|
205
|
+
### 4-5/10: Poor
|
|
206
|
+
- Many inconsistencies
|
|
207
|
+
- Many missing states
|
|
208
|
+
- Poor accessibility
|
|
209
|
+
|
|
210
|
+
### 0-3/10: Terrible
|
|
211
|
+
- No consistency
|
|
212
|
+
- No states
|
|
213
|
+
- Not accessible
|
|
214
|
+
|
|
215
|
+
### Detection Checklist
|
|
216
|
+
```
|
|
217
|
+
✅ Consistent styling
|
|
218
|
+
✅ Proper states (hover, focus, active, disabled)
|
|
219
|
+
✅ Accessible
|
|
220
|
+
✅ Reusable
|
|
221
|
+
✅ Well-structured
|
|
222
|
+
✅ Proper variants
|
|
223
|
+
```
|
|
224
|
+
|
|
225
|
+
---
|
|
226
|
+
|
|
227
|
+
## Dimension 6: Accessibility (10 points)
|
|
228
|
+
|
|
229
|
+
### 10/10: Excellent
|
|
230
|
+
- Semantic HTML (nav, section, article, main)
|
|
231
|
+
- Proper ARIA attributes
|
|
232
|
+
- Keyboard navigation
|
|
233
|
+
- Color contrast (4.5:1 for text)
|
|
234
|
+
- Screen reader support
|
|
235
|
+
- Focus indicators
|
|
236
|
+
|
|
237
|
+
### 8-9/10: Good
|
|
238
|
+
- Mostly semantic
|
|
239
|
+
- Most ARIA attributes
|
|
240
|
+
- Mostly keyboard accessible
|
|
241
|
+
- Good contrast
|
|
242
|
+
- Mostly screen reader accessible
|
|
243
|
+
|
|
244
|
+
### 6-7/10: Average
|
|
245
|
+
- Some semantic issues
|
|
246
|
+
- Some missing ARIA
|
|
247
|
+
- Some keyboard issues
|
|
248
|
+
- Some contrast issues
|
|
249
|
+
|
|
250
|
+
### 4-5/10: Poor
|
|
251
|
+
- Many semantic issues
|
|
252
|
+
- Many missing ARIA
|
|
253
|
+
- Poor keyboard support
|
|
254
|
+
- Poor contrast
|
|
255
|
+
|
|
256
|
+
### 0-3/10: Terrible
|
|
257
|
+
- No semantics
|
|
258
|
+
- No ARIA
|
|
259
|
+
- Not keyboard accessible
|
|
260
|
+
- Poor contrast
|
|
261
|
+
|
|
262
|
+
### Detection Checklist
|
|
263
|
+
```
|
|
264
|
+
✅ Semantic HTML
|
|
265
|
+
✅ Proper ARIA attributes
|
|
266
|
+
✅ Keyboard navigation
|
|
267
|
+
✅ Color contrast
|
|
268
|
+
✅ Screen reader support
|
|
269
|
+
✅ Focus indicators
|
|
270
|
+
```
|
|
271
|
+
|
|
272
|
+
---
|
|
273
|
+
|
|
274
|
+
## Dimension 7: Visual Hierarchy (10 points)
|
|
275
|
+
|
|
276
|
+
### 10/10: Excellent
|
|
277
|
+
- Clear focal points
|
|
278
|
+
- Proper size contrast
|
|
279
|
+
- Weight contrast
|
|
280
|
+
- Color contrast
|
|
281
|
+
- Spacing contrast
|
|
282
|
+
- Clear reading flow
|
|
283
|
+
|
|
284
|
+
### 8-9/10: Good
|
|
285
|
+
- Mostly clear hierarchy
|
|
286
|
+
- Good contrast
|
|
287
|
+
- Good flow
|
|
288
|
+
- Minor issues
|
|
289
|
+
|
|
290
|
+
### 6-7/10: Average
|
|
291
|
+
- Some hierarchy issues
|
|
292
|
+
- Some contrast issues
|
|
293
|
+
- Some flow issues
|
|
294
|
+
|
|
295
|
+
### 4-5/10: Poor
|
|
296
|
+
- Poor hierarchy
|
|
297
|
+
- Poor contrast
|
|
298
|
+
- Poor flow
|
|
299
|
+
|
|
300
|
+
### 0-3/10: Terrible
|
|
301
|
+
- No hierarchy
|
|
302
|
+
- No contrast
|
|
303
|
+
- No flow
|
|
304
|
+
|
|
305
|
+
### Detection Checklist
|
|
306
|
+
```
|
|
307
|
+
✅ Clear focal points
|
|
308
|
+
✅ Proper size contrast
|
|
309
|
+
✅ Weight contrast
|
|
310
|
+
✅ Color contrast
|
|
311
|
+
✅ Spacing contrast
|
|
312
|
+
✅ Clear reading flow
|
|
313
|
+
```
|
|
314
|
+
|
|
315
|
+
---
|
|
316
|
+
|
|
317
|
+
## Dimension 8: Consistency (10 points)
|
|
318
|
+
|
|
319
|
+
### 10/10: Excellent
|
|
320
|
+
- Consistent patterns
|
|
321
|
+
- Consistent naming
|
|
322
|
+
- Consistent spacing
|
|
323
|
+
- Consistent colors
|
|
324
|
+
- Consistent typography
|
|
325
|
+
- Consistent components
|
|
326
|
+
|
|
327
|
+
### 8-9/10: Good
|
|
328
|
+
- Mostly consistent
|
|
329
|
+
- Minor inconsistencies
|
|
330
|
+
- Good patterns
|
|
331
|
+
|
|
332
|
+
### 6-7/10: Average
|
|
333
|
+
- Some inconsistencies
|
|
334
|
+
- Some pattern issues
|
|
335
|
+
|
|
336
|
+
### 4-5/10: Poor
|
|
337
|
+
- Many inconsistencies
|
|
338
|
+
- Poor patterns
|
|
339
|
+
|
|
340
|
+
### 0-3/10: Terrible
|
|
341
|
+
- No consistency
|
|
342
|
+
- No patterns
|
|
343
|
+
|
|
344
|
+
### Detection Checklist
|
|
345
|
+
```
|
|
346
|
+
✅ Consistent patterns
|
|
347
|
+
✅ Consistent naming
|
|
348
|
+
✅ Consistent spacing
|
|
349
|
+
✅ Consistent colors
|
|
350
|
+
✅ Consistent typography
|
|
351
|
+
✅ Consistent components
|
|
352
|
+
```
|
|
353
|
+
|
|
354
|
+
---
|
|
355
|
+
|
|
356
|
+
## Dimension 9: Polish (10 points)
|
|
357
|
+
|
|
358
|
+
### 10/10: Excellent
|
|
359
|
+
- Subtle animations
|
|
360
|
+
- Proper loading states
|
|
361
|
+
- Error states
|
|
362
|
+
- Empty states
|
|
363
|
+
- Attention to detail
|
|
364
|
+
- Smooth transitions
|
|
365
|
+
|
|
366
|
+
### 8-9/10: Good
|
|
367
|
+
- Most animations present
|
|
368
|
+
- Most states present
|
|
369
|
+
- Good attention to detail
|
|
370
|
+
|
|
371
|
+
### 6-7/10: Average
|
|
372
|
+
- Some missing animations
|
|
373
|
+
- Some missing states
|
|
374
|
+
- Some detail issues
|
|
375
|
+
|
|
376
|
+
### 4-5/10: Poor
|
|
377
|
+
- Many missing animations
|
|
378
|
+
- Many missing states
|
|
379
|
+
- Poor attention to detail
|
|
380
|
+
|
|
381
|
+
### 0-3/10: Terrible
|
|
382
|
+
- No animations
|
|
383
|
+
- No states
|
|
384
|
+
- No attention to detail
|
|
385
|
+
|
|
386
|
+
### Detection Checklist
|
|
387
|
+
```
|
|
388
|
+
✅ Subtle animations
|
|
389
|
+
✅ Proper loading states
|
|
390
|
+
✅ Error states
|
|
391
|
+
✅ Empty states
|
|
392
|
+
✅ Attention to detail
|
|
393
|
+
✅ Smooth transitions
|
|
394
|
+
```
|
|
395
|
+
|
|
396
|
+
---
|
|
397
|
+
|
|
398
|
+
## Dimension 10: Code Quality (10 points)
|
|
399
|
+
|
|
400
|
+
### 10/10: Excellent
|
|
401
|
+
- Proper TypeScript types
|
|
402
|
+
- Good component structure
|
|
403
|
+
- Reusable components
|
|
404
|
+
- Maintainable code
|
|
405
|
+
- Good performance
|
|
406
|
+
- No code smells
|
|
407
|
+
|
|
408
|
+
### 8-9/10: Good
|
|
409
|
+
- Mostly typed
|
|
410
|
+
- Good structure
|
|
411
|
+
- Mostly reusable
|
|
412
|
+
- Good performance
|
|
413
|
+
|
|
414
|
+
### 6-7/10: Average
|
|
415
|
+
- Some typing issues
|
|
416
|
+
- Some structure issues
|
|
417
|
+
- Some reusability issues
|
|
418
|
+
|
|
419
|
+
### 4-5/10: Poor
|
|
420
|
+
- Many typing issues
|
|
421
|
+
- Poor structure
|
|
422
|
+
- Poor reusability
|
|
423
|
+
|
|
424
|
+
### 0-3/10: Terrible
|
|
425
|
+
- No TypeScript
|
|
426
|
+
- Poor structure
|
|
427
|
+
- Not reusable
|
|
428
|
+
|
|
429
|
+
### Detection Checklist
|
|
430
|
+
```
|
|
431
|
+
✅ Proper TypeScript types
|
|
432
|
+
✅ Good component structure
|
|
433
|
+
✅ Reusable components
|
|
434
|
+
✅ Maintainable code
|
|
435
|
+
✅ Good performance
|
|
436
|
+
✅ No code smells
|
|
437
|
+
```
|
|
438
|
+
|
|
439
|
+
---
|
|
440
|
+
|
|
441
|
+
## Score Calculation
|
|
442
|
+
|
|
443
|
+
```
|
|
444
|
+
Total Score = Sum of all dimensions (0-100)
|
|
445
|
+
```
|
|
446
|
+
|
|
447
|
+
### Score Interpretation
|
|
448
|
+
- **90-100**: Excellent (Vercel-quality, production-ready)
|
|
449
|
+
- **80-89**: Good (Minor improvements needed)
|
|
450
|
+
- **70-79**: Average (Several issues to fix)
|
|
451
|
+
- **60-69**: Below Average (Many issues to fix)
|
|
452
|
+
- **50-59**: Poor (Significant issues)
|
|
453
|
+
- **0-49**: Terrible (Complete rewrite needed)
|
|
454
|
+
|
|
455
|
+
---
|
|
456
|
+
|
|
457
|
+
## Priority Levels
|
|
458
|
+
|
|
459
|
+
### HIGH PRIORITY (Score Impact: 5-10 points)
|
|
460
|
+
- Accessibility issues (legal risk)
|
|
461
|
+
- Responsive issues (user experience)
|
|
462
|
+
- Color contrast issues (readability)
|
|
463
|
+
- Broken layouts
|
|
464
|
+
|
|
465
|
+
### MEDIUM PRIORITY (Score Impact: 2-4 points)
|
|
466
|
+
- Missing hover states
|
|
467
|
+
- Inconsistent spacing
|
|
468
|
+
- Typography issues
|
|
469
|
+
- Missing loading states
|
|
470
|
+
|
|
471
|
+
### LOW PRIORITY (Score Impact: 1 point)
|
|
472
|
+
- Minor polish issues
|
|
473
|
+
- Missing animations
|
|
474
|
+
- Code quality improvements
|
|
475
|
+
- Documentation
|
|
476
|
+
|
|
477
|
+
---
|
|
478
|
+
|
|
479
|
+
## Usage
|
|
480
|
+
|
|
481
|
+
### Step 1: Score Each Dimension
|
|
482
|
+
Rate the UI code on each of the 10 dimensions (0-10).
|
|
483
|
+
|
|
484
|
+
### Step 2: Calculate Total
|
|
485
|
+
Add up all scores to get a total out of 100.
|
|
486
|
+
|
|
487
|
+
### Step 3: Identify Issues
|
|
488
|
+
Note specific issues in each dimension.
|
|
489
|
+
|
|
490
|
+
### Step 4: Prioritize Fixes
|
|
491
|
+
Fix high-impact issues first:
|
|
492
|
+
1. Accessibility issues (legal risk)
|
|
493
|
+
2. Responsive issues (user experience)
|
|
494
|
+
3. Color contrast issues (readability)
|
|
495
|
+
4. Component issues (usability)
|
|
496
|
+
|
|
497
|
+
### Step 5: Re-score
|
|
498
|
+
After fixes, re-score to verify improvement.
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
# design-md Skill
|
|
2
|
+
|
|
3
|
+
> Generate and validate DESIGN.md files following Google's open-source design system standard.
|
|
4
|
+
|
|
5
|
+
## What Does This Skill Do?
|
|
6
|
+
|
|
7
|
+
The `design-md` skill teaches AI coding agents to:
|
|
8
|
+
1. **Generate** DESIGN.md files from project requirements
|
|
9
|
+
2. **Validate** existing DESIGN.md files for completeness
|
|
10
|
+
3. **Convert** DESIGN.md tokens to Tailwind CSS config
|
|
11
|
+
4. **Apply** design tokens consistently across components
|
|
12
|
+
|
|
13
|
+
## Why Use DESIGN.md?
|
|
14
|
+
|
|
15
|
+
DESIGN.md is an open-source format created by Google Labs Code that:
|
|
16
|
+
- Provides a single source of truth for design decisions
|
|
17
|
+
- Enables AI tools to understand design systems
|
|
18
|
+
- Ensures consistency across projects
|
|
19
|
+
- Facilitates design-to-code workflows
|
|
20
|
+
|
|
21
|
+
## Quick Start
|
|
22
|
+
|
|
23
|
+
### Generate a DESIGN.md
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
/design-md "Create a design system for a dark-themed analytics dashboard"
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
### Validate an Existing DESIGN.md
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
/design-md validate ./path/to/DESIGN.md
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### Convert to Tailwind Config
|
|
36
|
+
|
|
37
|
+
```bash
|
|
38
|
+
/design-md convert ./path/to/DESIGN.md
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## Features
|
|
42
|
+
|
|
43
|
+
- ✅ Automatic color palette generation
|
|
44
|
+
- ✅ Typography scale with proper ratios
|
|
45
|
+
- ✅ Consistent spacing system
|
|
46
|
+
- ✅ Component token definitions
|
|
47
|
+
- ✅ Dark theme support
|
|
48
|
+
- ✅ Tailwind CSS conversion
|
|
49
|
+
- ✅ Validation with detailed feedback
|
|
50
|
+
|
|
51
|
+
## File Structure
|
|
52
|
+
|
|
53
|
+
```
|
|
54
|
+
skills/design-md/
|
|
55
|
+
├── SKILL.md # Main skill instructions
|
|
56
|
+
├── README.md # This file
|
|
57
|
+
├── references/
|
|
58
|
+
│ └── design-md-spec.md # Full specification
|
|
59
|
+
├── examples/
|
|
60
|
+
│ ├── good-design.md # Good examples
|
|
61
|
+
│ └── bad-design.md # Bad examples
|
|
62
|
+
└── scripts/
|
|
63
|
+
└── validate.sh # Validation script
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
## Examples
|
|
67
|
+
|
|
68
|
+
### Input
|
|
69
|
+
```
|
|
70
|
+
Create a design system for a modern SaaS landing page
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
### Output
|
|
74
|
+
```markdown
|
|
75
|
+
# SaaS Landing Page Design System
|
|
76
|
+
|
|
77
|
+
## Colors
|
|
78
|
+
- primary: #2563eb
|
|
79
|
+
- background: #ffffff
|
|
80
|
+
- text: #111827
|
|
81
|
+
...
|
|
82
|
+
|
|
83
|
+
## Typography
|
|
84
|
+
- font-family: Inter, system-ui, sans-serif
|
|
85
|
+
- heading: 24px / 32px / 600 weight
|
|
86
|
+
- body: 16px / 24px / 400 weight
|
|
87
|
+
...
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
## Validation Rules
|
|
91
|
+
|
|
92
|
+
1. **Colors**: Must be valid hex (#RRGGBB)
|
|
93
|
+
2. **Typography**: Must include font-family, size, line-height, weight
|
|
94
|
+
3. **Spacing**: Must follow consistent scale
|
|
95
|
+
4. **Breakpoints**: Must be mobile-first
|
|
96
|
+
5. **Components**: Should define variant styles
|
|
97
|
+
|
|
98
|
+
## Resources
|
|
99
|
+
|
|
100
|
+
- [DESIGN.md Specification](https://github.com/google-labs-code/design.md)
|
|
101
|
+
- [Stitch by Google](https://stitch.withgoogle.com)
|
|
102
|
+
- [Tailwind CSS](https://tailwindcss.com)
|
|
103
|
+
|
|
104
|
+
## Contributing
|
|
105
|
+
|
|
106
|
+
See [CONTRIBUTING.md](../../CONTRIBUTING.md) for guidelines.
|