mirror of
https://github.com/nexu-io/open-design.git
synced 2026-06-01 03:14:35 +07:00
6f6bf31dd2
* Refactor project name from "Open Claude Design" to "Open Design" - Updated project name in package.json, package-lock.json, and README files. - Changed CLI commands and references from "ocd" to "od". - Adjusted file structure references in documentation and code to reflect new naming conventions. - Enhanced .gitignore to include new runtime data files. - Updated metadata in LICENSE file to match new project name. * Add contributing guidelines in English and Chinese - Introduced CONTRIBUTING.md and CONTRIBUTING.zh-CN.md to provide clear instructions for contributors. - Outlined contribution types, local setup instructions, and merging criteria for skills and design systems. - Enhanced README files to reference the new contributing guidelines.
120 lines
4.2 KiB
Markdown
120 lines
4.2 KiB
Markdown
---
|
||
name: simple-deck
|
||
description: |
|
||
Single-file horizontal-swipe HTML deck. Built by copying the seed
|
||
`assets/template.html` (which carries the proven 5-rule iframe nav script)
|
||
and pasting slide layouts from `references/layouts.md`. Pitch decks,
|
||
product overviews, study material — when you don't need the magazine
|
||
aesthetic of `magazine-web-ppt`.
|
||
triggers:
|
||
- "deck"
|
||
- "slides"
|
||
- "ppt"
|
||
- "presentation"
|
||
- "幻灯"
|
||
- "ppt 模板"
|
||
od:
|
||
mode: deck
|
||
scenario: product
|
||
preview:
|
||
type: html
|
||
entry: index.html
|
||
design_system:
|
||
requires: true
|
||
sections: [color, typography, layout, components]
|
||
---
|
||
|
||
# Simple Deck Skill
|
||
|
||
Produce a single-file horizontal-swipe HTML deck using the seed and layout library.
|
||
|
||
## Resource map
|
||
|
||
```
|
||
simple-deck/
|
||
├── SKILL.md ← you're reading this
|
||
├── assets/
|
||
│ └── template.html ← seed: tokens + slide primitives + proven nav script (READ FIRST)
|
||
└── references/
|
||
├── layouts.md ← 8 paste-ready slide layouts + theme-rhythm rules
|
||
└── checklist.md ← P0/P1/P2 self-review (rhythm spot-check at bottom)
|
||
```
|
||
|
||
## Workflow
|
||
|
||
### Step 0 — Pre-flight
|
||
|
||
1. **Read `assets/template.html`** end-to-end through the `<style>` block AND the `<script>` block. The script solves five iframe-specific bugs (real scroller detection, dual capture-phase listeners, auto-focus, no `scrollIntoView`, position persistence) — do not rewrite it.
|
||
2. **Read `references/layouts.md`** so you know the 8 layouts. Pay special attention to the "Theme rhythm" section — it's the rule that prevents the deck from feeling sleepy.
|
||
3. **Read the active DESIGN.md** — map its tokens to the six `:root` variables in the seed.
|
||
|
||
### Step 1 — Copy the seed
|
||
|
||
Copy `assets/template.html` to the project root as `index.html`. Replace the six `:root` variables with the active design system's tokens. Replace the page `<title>`.
|
||
|
||
### Step 2 — Decide slide count + theme rhythm BEFORE writing any slide
|
||
|
||
Default: 6 slides unless the brief says otherwise.
|
||
|
||
| Audience / format | Slides |
|
||
|---|---|
|
||
| Product overview / lightning talk (5–10 min) | 6 |
|
||
| Pitch deck (15 min) | 8–10 |
|
||
| Investor update / longer talk (20–30 min) | 12–18 |
|
||
|
||
Then write out the rhythm before any HTML — for example, 8 slides:
|
||
|
||
```
|
||
01 hero light center Cover
|
||
02 light Problem
|
||
03 hero dark center Big stat
|
||
04 light Three points
|
||
05 dark Pipeline
|
||
06 hero light center Quote
|
||
07 light Before / after
|
||
08 hero dark center Ask
|
||
```
|
||
|
||
A healthy sequence has:
|
||
- No 3+ same theme in a row
|
||
- ≥ 1 `hero dark` AND ≥ 1 `hero light` (for 8+ slides)
|
||
- Alternating breath every 3–4 slides
|
||
|
||
Show this rhythm sketch to the user *before* writing slide HTML — they can redirect cheaply.
|
||
|
||
### Step 3 — Paste and fill
|
||
|
||
For each planned slide, copy the matching `<section>` from `layouts.md` into the body. Replace bracketed text with real, specific copy. **No filler / no lorem.** If a slide feels empty, the layout is wrong — pick a different one.
|
||
|
||
Tag each slide with `data-screen-label="01 Cover"`, `"02 Problem"`, etc., in the order you wrote them. (The seed's first three slides already do this — extend the pattern.)
|
||
|
||
### Step 4 — Self-check
|
||
|
||
Run through `references/checklist.md`. The "Theme rhythm spot-check" at the end is non-negotiable:
|
||
|
||
```bash
|
||
grep 'class="slide' index.html
|
||
```
|
||
|
||
Read the resulting class list. If you see `light × 4 in a row`, swap one to `dark`. If no `hero dark` exists in an 8+ slide deck, promote one big-stat or closing slide.
|
||
|
||
### Step 5 — Emit the artifact
|
||
|
||
```
|
||
<artifact identifier="deck-slug" type="text/html" title="Deck Title">
|
||
<!doctype html>
|
||
<html>...</html>
|
||
</artifact>
|
||
```
|
||
|
||
One sentence before the artifact. Stop after `</artifact>`.
|
||
|
||
## Hard rules
|
||
|
||
- **Theme class on every slide** (`light` | `dark` | `hero light` | `hero dark`). Bare `class="slide"` = regression.
|
||
- **No 3+ same theme in a row.**
|
||
- **Display = serif via `var(--font-display)`.** `.h-hero` / `.h-xl` / `.h-md` already enforce.
|
||
- **One accent per slide, used at most twice.**
|
||
- **Don't rewrite the nav script.** It's proven.
|
||
- **No `scrollIntoView()`.** Breaks iframe.
|
||
- **`data-screen-label` on every slide.**
|