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

Commit 41b1d5b

Browse files
feat(#37): update doc for markdown and notes
1 parent 943c7f0 commit 41b1d5b

File tree

1 file changed

+43
-6
lines changed

1 file changed

+43
-6
lines changed

doc/markdown/markdown.md

Lines changed: 43 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,13 @@ This documentation has for goal to introduce you briefly on how is it working ou
88
- [Editing](#editing)
99
- [Example](#example)
1010
- [Attributes](#attributes)
11+
- [Notes](#notes)
1112

1213
## Introduction
1314

1415
It's pretty simple, the goal of the editing with Markdown is to offer the same abilities as if you would have while editing your talk with HTML.
1516

16-
When you edit your talk with Markdown, furthermore than the set of common supported tags, the [DeckDeckGo Webpack Markdown Plugin](https://github.com/deckgo/deckdeckgo-webpack-markdown-plugin) extend these by adding the support of the different [DeckDeckGo] slides as documented in the 👉 [extended documentation](doc/slides/slides.md) 👈.
17+
When you edit your talk with Markdown, furthermore than the set of common supported tags, the [DeckDeckGo Webpack Markdown Plugin](https://github.com/deckgo/deckdeckgo-webpack-plugins) extend these by adding the support of the different [DeckDeckGo] slides as documented in the 👉 [extended documentation](doc/slides/slides.md) 👈.
1718

1819
Your Markdown code will, through the help of the plugin, be compiled and injected in the `index.html` distribution file at build time. Doing so, your [DeckDeckGo] presentation will remain SEO friendly even without server side rendering.
1920

@@ -25,7 +26,7 @@ Furthermore the plugin takes care of injecting the content you would provide in
2526

2627
### Example
2728

28-
The following `</deckgo-slide-title>` slide:
29+
The following `<deckgo-slide-title/>` slide:
2930

3031
```
3132
--- title
@@ -39,17 +40,17 @@ would be parsed into:
3940
```
4041
<deckgo-slide-title>
4142
<h1 slot="title">My presentation title</h1>
42-
<p slot="content">
43-
Hello World 🚀
44-
</p>
43+
<div slot="content">
44+
<p>Hello World 🚀</p>
45+
</div>
4546
</deckgo-slide-title>
4647
```
4748

4849
### Attributes
4950

5051
As some templates needs attributes, you would also be able to specify them in Markdown.
5152

52-
For example the `</deckgo-slide-gif>` slide:
53+
For example the `<deckgo-slide-gif/>` slide:
5354

5455
```
5556
--- gif src="https://media.giphy.com/media/xUA7baWfTjfHGLZc3e/giphy.gif" alt="My gif" fullscreen="true"
@@ -70,4 +71,40 @@ would be parsed into:
7071
</deckgo-slide-gif>
7172
```
7273

74+
### Notes
75+
76+
To add some notes to a particular slide, use the separator `***` and write down your notes afterwards.
77+
78+
Optionally, if you wish to display your notes in your deck, you could also use the attribute `show`.
79+
80+
```
81+
--- title
82+
# My presentation title
83+
84+
Hello World 🚀
85+
86+
***
87+
88+
I should not forget to think about that during my talk
89+
90+
...and say hello to mum
91+
```
92+
93+
would be parsed into:
94+
95+
```
96+
<deckgo-slide-title>
97+
<h1 slot="title">My presentation title</h1>
98+
<div slot="content">
99+
<p>Hello World 🚀</p>
100+
</div>
101+
<div slot="notes">
102+
I should not forget to think about that during my talk
103+
104+
...and say hello to mum
105+
</div>
106+
</deckgo-slide-title>
107+
```
108+
109+
73110
[DeckDeckGo]: https://deckdeckgo.com

0 commit comments

Comments
 (0)