Skip to content

Commit 3c26bfb

Browse files
committed
adding slides
1 parent 5ea9a35 commit 3c26bfb

1 file changed

Lines changed: 44 additions & 12 deletions

File tree

CONTRIBUTING.md

Lines changed: 44 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ This repo basically brings together slides and slide-decks (which themselves sou
1919
├── README.md
2020
├── scripts # <- scripts to take care of build logic and pulling metadata from slides.md YAML frontmatter
2121
├── slide-decks
22-
└── themes # <- themes for styling a slide deck
22+
└── themes # <- themes including layouts for styling a slide deck
2323
```
2424

2525
### Adding a new slide deck
@@ -38,21 +38,53 @@ slide-decks/<NameOfSlideDeck>
3838
Note: Only slide decks **following exactly** this path and file name (`slides.md`) convention are automatically picked up.
3939

4040

41-
#### slides.md
41+
#### Adding slides
4242

43-
To compile slides from other slides, use this logic
43+
There's two main ways to add slides
4444

45-
```md
46-
---
47-
src: path/to/slide
48-
---
49-
```
45+
1. Adding it directly inside `slides.md`:
46+
47+
```markdown
48+
---
49+
50+
# Header slide 1
51+
52+
Content slide 1
53+
54+
---
55+
56+
# Header slide 2
57+
58+
Content slide 2
59+
60+
---
61+
62+
```
63+
64+
65+
2. Compile slides from other slides, use this src logic:
66+
67+
```md
68+
---
69+
src: path/to/slide
70+
---
71+
```
72+
73+
E.g.
74+
75+
```md
76+
---
77+
src: ../../EduBricks-EduPaths/EduBricks/my-brick.md
78+
---
79+
```
5080

51-
E.g.
81+
You can also selectively add slides with the `#` logic at the end
5282

53-
---
54-
src: ../../EduBricks-EduPaths/EduBricks/my-brick.md
55-
---
83+
```md
84+
---
85+
src: ../../EduBricks-EduPaths/EduBricks/my-brick.md#1,2
86+
---
87+
```
5688

5789

5890
## Breaking Links

0 commit comments

Comments
 (0)