Skip to content
This repository was archived by the owner on Feb 6, 2024. It is now read-only.

Commit d180a7f

Browse files
doc(#37): add note regarding attribute show for the notes
1 parent 1431a84 commit d180a7f

File tree

1 file changed

+37
-10
lines changed

1 file changed

+37
-10
lines changed

doc/slides/slides.md

Lines changed: 37 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ Both slots `title` and `content` are optional. Without providing one of them, th
9393

9494
##### Notes
9595

96-
Optionally a slot `notes` could be use to add some notes regarding the particular slide. These will `not` be displayed in the presentation but `displayed` in the [remote control](https://deckdeckgo.app).
96+
Optionally a slot `notes` could be use to add some notes regarding the particular slide. These will be automatically `displayed` in the [remote control](https://deckdeckgo.app).
9797

9898
```
9999
<deckgo-deck>
@@ -102,7 +102,18 @@ Optionally a slot `notes` could be use to add some notes regarding the particula
102102
<div slot="notes">A note regarding this particular slide</div>
103103
</deckgo-slide-title>
104104
</deckgo-deck>
105-
```
105+
```
106+
107+
If you are using the [DeckDeckGo] starter kit and wish to make your notes accessible to anyone, you would need to mark them with an attribute `show`.
108+
109+
```
110+
<deckgo-deck>
111+
<deckgo-slide-title>
112+
<h1 slot="title">My presentation title</h1>
113+
<div slot="notes" show>A note displayed in the presentation within a modal accessible for anyone</div>
114+
</deckgo-slide-title>
115+
</deckgo-deck>
116+
```
106117

107118
#### Attributes
108119

@@ -173,7 +184,9 @@ Both slots `title` and `content` are optional. Without providing one of them, th
173184

174185
##### Notes
175186

176-
Optionally a slot `notes` could be use to add some notes regarding the particular slide. These will `not` be displayed in the presentation but `displayed` in the [remote control](https://deckdeckgo.app).
187+
Optionally a slot `notes` could be use to add some notes regarding the particular slide. These will be automatically `displayed` in the [remote control](https://deckdeckgo.app).
188+
189+
If you are using the [DeckDeckGo] starter kit and wish to make your notes accessible to anyone, you would need to mark them with an attribute `show`.
177190

178191
#### Attributes
179192

@@ -248,7 +261,9 @@ Note: The slot `title` is per default hidden even if you provide it. See attribu
248261

249262
##### Notes
250263

251-
Optionally a slot `notes` could be use to add some notes regarding the particular slide. These will `not` be displayed in the presentation but `displayed` in the [remote control](https://deckdeckgo.app).
264+
Optionally a slot `notes` could be use to add some notes regarding the particular slide. These will be automatically `displayed` in the [remote control](https://deckdeckgo.app).
265+
266+
If you are using the [DeckDeckGo] starter kit and wish to make your notes accessible to anyone, you would need to mark them with an attribute `show`.
252267

253268
#### Attributes
254269

@@ -315,7 +330,9 @@ The slots `title`, `header` and `footer` are both optional. `header` and `footer
315330

316331
##### Notes
317332

318-
Optionally a slot `notes` could be use to add some notes regarding the particular slide. These will `not` be displayed in the presentation but `displayed` in the [remote control](https://deckdeckgo.app).
333+
Optionally a slot `notes` could be use to add some notes regarding the particular slide. These will be automatically `displayed` in the [remote control](https://deckdeckgo.app).
334+
335+
If you are using the [DeckDeckGo] starter kit and wish to make your notes accessible to anyone, you would need to mark them with an attribute `show`.
319336

320337
#### Gif component
321338

@@ -371,7 +388,9 @@ The slot `title` is optional.
371388

372389
##### Notes
373390

374-
Optionally a slot `notes` could be use to add some notes regarding the particular slide. These will `not` be displayed in the presentation but `displayed` in the [remote control](https://deckdeckgo.app).
391+
Optionally a slot `notes` could be use to add some notes regarding the particular slide. These will be automatically `displayed` in the [remote control](https://deckdeckgo.app).
392+
393+
If you are using the [DeckDeckGo] starter kit and wish to make your notes accessible to anyone, you would need to mark them with an attribute `show`.
375394

376395
#### Chart components
377396

@@ -435,7 +454,9 @@ The slot `title` is optional.
435454

436455
##### Notes
437456

438-
Optionally a slot `notes` could be use to add some notes regarding the particular slide. These will `not` be displayed in the presentation but `displayed` in the [remote control](https://deckdeckgo.app).
457+
Optionally a slot `notes` could be use to add some notes regarding the particular slide. These will be automatically `displayed` in the [remote control](https://deckdeckgo.app).
458+
459+
If you are using the [DeckDeckGo] starter kit and wish to make your notes accessible to anyone, you would need to mark them with an attribute `show`.
439460

440461
##### Youtube component
441462

@@ -527,7 +548,9 @@ The slots `title` and `code` are optional.
527548

528549
##### Notes
529550

530-
Optionally a slot `notes` could be use to add some notes regarding the particular slide. These will `not` be displayed in the presentation but `displayed` in the [remote control](https://deckdeckgo.app).
551+
Optionally a slot `notes` could be use to add some notes regarding the particular slide. These will be automatically `displayed` in the [remote control](https://deckdeckgo.app).
552+
553+
If you are using the [DeckDeckGo] starter kit and wish to make your notes accessible to anyone, you would need to mark them with an attribute `show`.
531554

532555
#### Code components
533556

@@ -627,7 +650,9 @@ Notes:
627650

628651
##### Notes
629652

630-
Optionally a slot `notes` could be use to add some notes regarding the particular slide. These will `not` be displayed in the presentation but `displayed` in the [remote control](https://deckdeckgo.app).
653+
Optionally a slot `notes` could be use to add some notes regarding the particular slide. These will be automatically `displayed` in the [remote control](https://deckdeckgo.app).
654+
655+
If you are using the [DeckDeckGo] starter kit and wish to make your notes accessible to anyone, you would need to mark them with an attribute `show`.
631656

632657
##### Social components
633658

@@ -747,7 +772,9 @@ The slots `title` and `content` are optional.
747772

748773
##### Notes
749774

750-
Optionally a slot `notes` could be use to add some notes regarding the particular slide. These will `not` be displayed in the presentation but `displayed` in the [remote control](https://deckdeckgo.app).
775+
Optionally a slot `notes` could be use to add some notes regarding the particular slide. These will be automatically `displayed` in the [remote control](https://deckdeckgo.app).
776+
777+
If you are using the [DeckDeckGo] starter kit and wish to make your notes accessible to anyone, you would need to mark them with an attribute `show`.
751778

752779
#### Code components
753780

0 commit comments

Comments
 (0)