Skip to content

Commit fd3b73d

Browse files
author
Leo
committed
Update README.md
1 parent b335d4b commit fd3b73d

File tree

1 file changed

+19
-18
lines changed

1 file changed

+19
-18
lines changed

README.md

Lines changed: 19 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,16 @@
22
animations and media, which can be visualized in a web browser even without
33
an internet connection.**
44

5-
**See for yourself**: check out the [live demo](https://da_doomer.gitlab.io/markdown-slides) (and the source file [`presentation.md`](example/presentation.md)).
6-
75
See the official [repo](https://gitlab.com/da_doomer/markdown-slides) on Gitlab.
86

97
This program appropriately inserts markdown files into Reveal.js files,
108
completely avoiding the need to edit HTML files directly.
119

10+
# Live demo
11+
12+
**See for yourself**: check out the [live demo](https://da_doomer.gitlab.io/markdown-slides) (and the source file [`presentation.md`](example/presentation.md)).
13+
14+
1215
# Installation
1316

1417
```
@@ -48,27 +51,25 @@ connection to display the presentations.
4851

4952
# Syntax:
5053

54+
You will probably only need to break slides:
55+
56+
```md
57+
# My title
58+
A subtitle maybe
59+
60+
[comment]: # (!!! Comments starting with this are slide breaks)
61+
62+
Second slide. Easy :D
63+
```
64+
65+
Other options are documented in the example presentation [`presentation.md`](example/presentation.md).
66+
5167
If you need a quick refresher on markdown see e.g.
5268
[this cheatsheet](https://www.markdownguide.org/cheat-sheet/), the
5369
[CommonMark reference page](https://commonmark.org/help/), or this
5470
[Gfm tutorial](https://guides.github.com/features/mastering-markdown/).
5571

5672
You will not have to break your markdown files to use this program. Control
57-
Reveal.js' theme and options using CommonMark-compliant comments:
58-
59-
```md
60-
[comment]: # (Set the theme:)
61-
[comment]: # (THEME = white)
62-
[comment]: # (CODE_THEME = white)
63-
64-
[comment]: # (Pass optional settings to reveal.js:)
65-
[comment]: # (controls: false)
66-
[comment]: # (keyboard: true)
67-
[comment]: # (markdown: { smartypants: true })
68-
[comment]: # (hash: true)
69-
70-
[comment]: # (Comments starting with three or more exclamation signs mark slide-breaks)
71-
[comment]: # (!!!)
72-
```
73+
Reveal.js' theme and options using CommonMark-compliant comments.
7374

7475
Everything but slide-break comments and option comments is passed to Reveal.js verbatim. Check out their documentation, especially the [markdown section](https://revealjs.com/markdown/).

0 commit comments

Comments
 (0)