Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions .github/workflows/regression-gate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,11 @@ jobs:
- name: Checkout
uses: actions/checkout@v4

- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: "3.11"

- name: Validate SKILL.md frontmatter
run: |
head -1 SKILL.md | grep -q '^---$' || { echo "SKILL.md must start with YAML frontmatter"; exit 1; }
Expand All @@ -39,3 +44,9 @@ jobs:
echo "$code $url"
[ "$code" = "200" ] || { echo "FAIL: $url returned $code"; exit 1; }
done

- name: Test scripts/fetch-style.py
run: |
python3 scripts/fetch-style.py glassmorphism --tokens | grep -q "TOKENS" || { echo "fetch-style.py failed"; exit 1; }
python3 scripts/fetch-style.py neo-brutalist --recipes | grep -q "STYLE:" || { echo "fetch-style.py --recipes failed"; exit 1; }
python3 scripts/fetch-style.py --search cyberpunk | grep -q "vaporwave" || { echo "fetch-style.py --search failed"; exit 1; }
30 changes: 0 additions & 30 deletions README.md

This file was deleted.

124 changes: 40 additions & 84 deletions SKILL.md
Original file line number Diff line number Diff line change
@@ -1,73 +1,57 @@
---
name: stylekit
description: Apply a specific, consistent visual style to frontend UI you are generating. Use when building or styling web UI (pages, components, dashboards, landing pages) and you want a named aesthetic — Glassmorphism, Neo-Brutalist, Cyberpunk, Bauhaus, Apple, Stripe, Linear, and many more — instead of generic AI defaults. StyleKit gives you design tokens, component recipes, and AI rules for each style, with themes installable through the shadcn registry.
metadata:
homepage: https://www.stylekit.top
---

# StyleKit

StyleKit is an open-source style library for AI coding with 146 curated
visual styles, each with machine-readable design tokens, component recipes, and
AI rules. Use it to make the UI you generate look like a deliberate, named style
instead of generic AI output.

## When to use

- The user asks for a specific look ("make it look like Stripe", "cyberpunk
dashboard", "cozy cottagecore blog", "brutalist landing page").
- You are generating frontend UI and want a coherent, consistent design system
rather than ad-hoc styling.
- The user wants their AI-generated site to match an aesthetic across many
components.
Apply StyleKit's 146 curated visual styles to generated UI. Use the catalog, fetch the exact spec, install the theme, and honor the style's rules.

## Workflow

For any request, follow this order:

1. **Pick a style** — match the user's intent to a catalog slug.
2. **Fetch the full spec** — pull tokens, recipes, and AI rules for that slug.
3. **Install the theme** (optional) — drop the shadcn registry theme into the project.
4. **Generate with the rules** — use the style's exact tokens and do/don't lists.

## Step 1 — Pick a style

Browse the catalog and machine-readable index:
Match the user's request to a slug from the catalog:

- Human catalog: https://www.stylekit.top/styles
- Browse by theme: https://www.stylekit.top/collections (dark-mode, retro-vintage,
anime-manga, game-ui, colorful-bold, hand-drawn)
- Colors / hex codes: https://www.stylekit.top/colors
- JSON list of every style: `GET https://www.stylekit.top/api/styles`
→ `{ total, styles: [{ slug, nameEn, description, styleType, keywords, colors, ... }] }`
- Full machine-readable spec for agents: https://www.stylekit.top/llms-full.txt
- Markdown spec for agents: https://www.stylekit.top/llms.txt
- **Human catalog**: https://www.stylekit.top/styles
- **By theme**: https://www.stylekit.top/collections (dark-mode, retro-vintage, anime-manga, game-ui, colorful-bold, hand-drawn)
- **Colors / hex codes**: https://www.stylekit.top/colors
- **Machine-readable list**: `GET https://www.stylekit.top/api/styles` → `{ total, styles: [{ slug, nameEn, description, styleType, keywords, colors }] }`
- **Common style signatures**: see [references/style-signatures.md](references/style-signatures.md) for the visual traits of popular styles

Each style has a `slug` (e.g. `glassmorphism`, `neo-brutalist`, `stripe-style`,
`bauhaus`). You need the slug for the next step.
For an ambiguous request, scan the `/api/styles` list keywords and pick the closest slug. When in doubt, ask the user between two candidates.

## Step 2 — Fetch the full spec

For the chosen slug, fetch the machine-readable spec — do not guess tokens or
rules from memory (styles get updated):
Fetch the machine-readable spec for the chosen slug — do not guess tokens or rules from memory (styles get updated):

- Full style pack: `GET https://www.stylekit.top/api/styles/{slug}`
→ `{ slug, name, description, philosophy, doList, dontList, aiRules, colors, components, globalCss, tokens, recipes, version }`
- Markdown rendering: `GET https://www.stylekit.top/api/styles/{slug}/md`
- Tokens only: `GET https://www.stylekit.top/api/styles/{slug}/tokens`
- Recipes only: `GET https://www.stylekit.top/api/styles/{slug}/recipes`
- Human page: https://www.stylekit.top/styles/{slug}
```bash
python3 scripts/fetch-style.py <slug> # full spec: tokens, recipes, rules
python3 scripts/fetch-style.py <slug> --tokens # tokens only
python3 scripts/fetch-style.py <slug> --recipes # recipes only
```

The script prints a compact spec for code generation. Raw endpoints are also available:

### Understand the style anatomy
- Full pack: `GET https://www.stylekit.top/api/styles/{slug}`
- Markdown: `GET https://www.stylekit.top/api/styles/{slug}/md`
- Tokens: `GET https://www.stylekit.top/api/styles/{slug}/tokens`
- Recipes: `GET https://www.stylekit.top/api/styles/{slug}/recipes`
- Human page: https://www.stylekit.top/styles/{slug}

Process the spec fields in this priority order:
### Process the spec in priority order

1. **aiRules** — compact instruction string written specifically for AI. Highest priority; overrides general patterns when they conflict.
2. **doList / dontList** — hard constraints, not suggestions. Every generated component must satisfy all items.
3. **philosophy** — the "why" behind the style. Read first to determine ambiguous decisions (visual hierarchy, spacing intent, mood).
4. **colors** — `{ primary, secondary, accent[] }`. Always the source of truth for the palette.
5. **tokens** — semantic categories mapped to exact Tailwind classes. Use them instead of inventing classes.
6. **components** — code templates for button, card, input (and optionally nav, hero, footer). Starting points, not copy-paste targets.
1. **aiRules** — instruction string written for AI. Highest priority; overrides general patterns when they conflict.
2. **doList / dontList** — hard constraints. Every generated component must satisfy all items.
3. **philosophy** — the "why" behind the style. Determines ambiguous decisions (visual hierarchy, spacing, mood).
4. **colors** — `{ primary, secondary, accent[] }`. Source of truth for the palette.
5. **tokens** — semantic categories mapped to exact Tailwind classes. Use instead of inventing classes.
6. **components** — code templates for button, card, input (and optionally nav, hero, footer). Starting points.
7. **globalCss** — base CSS that must be included in the page/layout when using this style.

## Step 3 — Install the theme (optional)
Expand All @@ -78,25 +62,19 @@ Drop the theme into an existing shadcn/ui project (Tailwind v4):
npx shadcn add https://www.stylekit.top/r/<slug>.json
```

Requires a `tsconfig.json` in the target project. The CLI injects the style's
light + dark `cssVars` into `globals.css`. Full guide: https://www.stylekit.top/developers
Requires a `tsconfig.json` in the target project. Injects the style's light + dark `cssVars` into `globals.css`. Full guide: https://www.stylekit.top/developers

## Step 4 — Generate with the style's rules

1. Use the style's **design tokens** (colors, spacing, typography, shadows,
radii) — do not invent your own values.
2. Follow the **AI rules** and **doList/dontList** — these encode what makes the
style read as intentional (e.g. Neo-Brutalist: thick borders, hard shadows,
no rounded corners; Glassmorphism: high blur, translucency, inner glow).
3. Use the **component templates** and **recipes** as starting points; adapt to
the user's content.
4. Keep the style consistent across every component you generate in the session,
including responsive breakpoints (mobile-first).
1. Use the style's **design tokens** (colors, spacing, typography, shadows, radii) — do not invent your own values.
2. Follow the **AI rules** and **doList/dontList** — they encode what makes the style read as intentional (e.g. Neo-Brutalist: thick borders, hard shadows, no rounded corners; Glassmorphism: high blur, translucency, inner glow).
3. Use **component templates** and **recipes** as starting points; adapt to the user's content.
4. Keep the style consistent across every component in the session, including responsive breakpoints (mobile-first).

### Example — good (uses exact token classes)
### Good — uses exact token classes

```tsx
// Neo-Brutalist button — token classes from the style pack
// Neo-Brutalist button — token classes from the fetched spec
<button className="
px-6 py-3
bg-[#ff006e] text-white font-black
Expand All @@ -110,7 +88,7 @@ light + dark `cssVars` into `globals.css`. Full guide: https://www.stylekit.top/
</button>
```

### Example — bad (guessing classes, ignoring tokens)
### Bad — guessing classes, ignoring tokens

```tsx
// WRONG: rounded-lg violates neo-brutalist (must be rounded-none)
Expand All @@ -129,29 +107,7 @@ light + dark `cssVars` into `globals.css`. Full guide: https://www.stylekit.top/
- **Don't hardcode hex values.** Use the style's `colors` object and token classes.
- **Don't rely on memory — always fetch the spec.** Styles get updated; stale data leads to violations.

## Popular styles — visual signatures

| Style | Key Visual Traits | Forbidden | Required |
|-------|------------------|-----------|----------|
| `neo-brutalist` | Black borders, hard shadows, no rounding | `rounded-*`, `shadow-lg`, gradients | `rounded-none`, `border-black`, hard-edge `shadow-[...]` |
| `glassmorphism` | Frosted glass, blur, translucent | `rounded-none`, `bg-white`, `border-black` | `backdrop-blur-*`, `bg-white/N`, `border-white/N` |
| `neumorphism` | Soft extruded surfaces, subtle shadows | Hard shadows, high contrast borders | Dual shadows (light + dark), soft bg |
| `claymorphism` | Puffy 3D clay look, inner shadows | Flat shadows, sharp corners | Inner shadow, rounded corners, pastel bg |
| `apple-style` | Clean, precise, SF Pro feel | Heavy borders, loud colors | Subtle shadows, system fonts, generous whitespace |
| `material-design` | Elevation system, ripple effects | Hard-edge shadows, no-radius | `shadow-md`, `rounded-lg`, elevation layers |
| `pixel-art` | Pixelated edges, 8-bit aesthetic | Smooth gradients, anti-aliased borders | `rounded-none`, pixel fonts, step-based colors |
| `cyberpunk-neon` | Neon glows, dark bg, electric colors | Pastel colors, soft shadows | Neon `shadow-[0_0_Npx_color]`, dark bg, bright accents |
| `swiss-style` | Grid-based, Helvetica, minimal | Decorative elements, rounded corners | Grid alignment, sans-serif, high contrast |
| `art-deco` | Gold accents, geometric patterns, luxury | Casual fonts, muted colors | Gold/brass tones, geometric borders, serif fonts |
| `ghibli-style` | Warm watercolor, hand-drawn feel | Sharp edges, neon colors | Soft pastels, rounded shapes, warm tones |
| `vaporwave` | Purple/pink gradients, retro-futurism | Muted earth tones, minimal palette | Gradient bg, neon pink/cyan, retro fonts |
| `dark-mode` | Dark surfaces, subtle elevation | Pure white bg, low contrast | Dark bg, muted text, subtle borders |
| `editorial` | Typography-driven, magazine layout | Heavy UI chrome, small text | Large type, generous spacing, serif headings |
| `korean-minimal` | Soft, airy, pastel, generous whitespace | Heavy borders, loud colors | Subtle pastels, thin borders, rounded-2xl |

## Notes

- Styles span three axes: brand-inspired (Apple, Stripe, Linear, Notion,
GitHub), aesthetic (Glassmorphism, Neo-Brutalist, Cyberpunk, Vaporwave), and
cultural (Bauhaus, Ghibli, Wabi-Sabi, Ukiyo-e).
- Everything is free and open source (MIT). Full docs: https://www.stylekit.top/developers
## Resources

- `references/style-signatures.md` — visual traits, forbidden, and required classes for popular styles
- `scripts/fetch-style.py` — fetch a style's spec from the API and print a compact code-generation reference
33 changes: 33 additions & 0 deletions references/style-signatures.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Popular Style Signatures

Visual traits, forbidden classes, and required classes for the most-requested StyleKit styles. For any style, always fetch the live spec — this table is a quick orientation aid, not a replacement for the API.

| Style | Key Visual Traits | Forbidden | Required |
|-------|------------------|-----------|----------|
| `neo-brutalist` | Black borders, hard shadows, no rounding | `rounded-*`, `shadow-lg`, gradients | `rounded-none`, `border-black`, hard-edge `shadow-[...]` |
| `glassmorphism` | Frosted glass, blur, translucent | `rounded-none`, `bg-white`, `border-black` | `backdrop-blur-*`, `bg-white/N`, `border-white/N` |
| `neumorphism` | Soft extruded surfaces, subtle shadows | Hard shadows, high contrast borders | Dual shadows (light + dark), soft bg |
| `claymorphism` | Puffy 3D clay look, inner shadows | Flat shadows, sharp corners | Inner shadow, rounded corners, pastel bg |
| `apple-style` | Clean, precise, SF Pro feel | Heavy borders, loud colors | Subtle shadows, system fonts, generous whitespace |
| `material-design` | Elevation system, ripple effects | Hard-edge shadows, no-radius | `shadow-md`, `rounded-lg`, elevation layers |
| `pixel-art` | Pixelated edges, 8-bit aesthetic | Smooth gradients, anti-aliased borders | `rounded-none`, pixel fonts, step-based colors |
| `cyberpunk-neon` | Neon glows, dark bg, electric colors | Pastel colors, soft shadows | Neon `shadow-[0_0_Npx_color]`, dark bg, bright accents |
| `swiss-style` | Grid-based, Helvetica, minimal | Decorative elements, rounded corners | Grid alignment, sans-serif, high contrast |
| `art-deco` | Gold accents, geometric patterns, luxury | Casual fonts, muted colors | Gold/brass tones, geometric borders, serif fonts |
| `ghibli-style` | Warm watercolor, hand-drawn feel | Sharp edges, neon colors | Soft pastels, rounded shapes, warm tones |
| `vaporwave` | Purple/pink gradients, retro-futurism | Muted earth tones, minimal palette | Gradient bg, neon pink/cyan, retro fonts |
| `dark-mode` | Dark surfaces, subtle elevation | Pure white bg, low contrast | Dark bg, muted text, subtle borders |
| `editorial` | Typography-driven, magazine layout | Heavy UI chrome, small text | Large type, generous spacing, serif headings |
| `korean-minimal` | Soft, airy, pastel, generous whitespace | Heavy borders, loud colors | Subtle pastels, thin borders, rounded-2xl |

## Style axes

- **Brand-inspired**: Apple, Stripe, Linear, Notion, GitHub
- **Aesthetic**: Glassmorphism, Neo-Brutalist, Cyberpunk, Vaporwave
- **Cultural**: Bauhaus, Ghibli, Wabi-Sabi, Ukiyo-e

## Browsing the catalog

- All styles: https://www.stylekit.top/styles
- JSON list: `GET https://www.stylekit.top/api/styles`
- By collection (dark-mode, retro-vintage, anime-manga, game-ui, colorful-bold, hand-drawn): https://www.stylekit.top/collections
Loading
Loading