You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update documentation to clarify slide layout rules for code and images
- Simplify centered vs two-column slide descriptions in example.md
- Update README to specify any heading level works with code/images for two-column layout
- Add image example alongside code in two-column slide section
- Condense click-through states explanation and move Magic Move reference inline
Copy file name to clipboardExpand all lines: README.md
+6-38Lines changed: 6 additions & 38 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -56,17 +56,17 @@ slicode example.md build
56
56
57
57
## Markdown Format
58
58
59
-
### Centered slides — `#`
59
+
### Centered slides — heading without code/image
60
60
61
61
```md
62
62
# Welcome
63
63
64
64
This text is centered on the slide.
65
65
```
66
66
67
-
### Two-column slides — `##`
67
+
### Two-column slides — any heading + code or image
68
68
69
-
Heading and text on the left, code on the right:
69
+
Heading and text on the left, code or image on the right:
70
70
71
71
```md
72
72
## Getting Started
@@ -76,45 +76,13 @@ Here's a simple example.
76
76
```python
77
77
print("hello")
78
78
```
79
-
```
80
-
81
-
### Click-through states
82
-
83
-
Consecutive `##` sections with code blocks become animated click states on a single slide. Code transitions use [Magic Move](https://sli.dev/features/magic-move), text crossfades smoothly:
84
-
85
-
```md
86
-
## Step 1
87
-
88
-
Define a function.
89
-
90
-
```python
91
-
def greet():
92
-
pass
93
-
```
94
79
95
-
Add the body.
80
+
## Architecture
96
81
97
-
```python
98
-
def greet():
99
-
print("hello")
100
-
```
101
-
102
-
## Step 2
103
-
104
-
Call it.
105
-
106
-
```python
107
-
def greet():
108
-
print("hello")
109
-
110
-
greet()
111
-
```
82
+

112
83
```
113
84
114
-
This produces **one** two-column slide with **3 click states**:
115
-
- Click 0: "Step 1" heading, first text, first code
116
-
- Click 1: same heading (no animation), second text, code morphs
117
-
- Click 2: heading changes to "Step 2" (animated), third text, code morphs again
85
+
Consecutive sections with code merge into one slide with animated click-through states using [Magic Move](https://sli.dev/features/magic-move).
0 commit comments