|
2 | 2 | animations and media, which can be visualized in a web browser even without
|
3 | 3 | an internet connection.**
|
4 | 4 |
|
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 |
| - |
7 | 5 | See the official [repo](https://gitlab.com/da_doomer/markdown-slides) on Gitlab.
|
8 | 6 |
|
9 | 7 | This program appropriately inserts markdown files into Reveal.js files,
|
10 | 8 | completely avoiding the need to edit HTML files directly.
|
11 | 9 |
|
| 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 | + |
12 | 15 | # Installation
|
13 | 16 |
|
14 | 17 | ```
|
@@ -48,27 +51,25 @@ connection to display the presentations.
|
48 | 51 |
|
49 | 52 | # Syntax:
|
50 | 53 |
|
| 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 | + |
51 | 67 | If you need a quick refresher on markdown see e.g.
|
52 | 68 | [this cheatsheet](https://www.markdownguide.org/cheat-sheet/), the
|
53 | 69 | [CommonMark reference page](https://commonmark.org/help/), or this
|
54 | 70 | [Gfm tutorial](https://guides.github.com/features/mastering-markdown/).
|
55 | 71 |
|
56 | 72 | 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. |
73 | 74 |
|
74 | 75 | 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