aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHakim El Hattab <hakim.elhattab@gmail.com>2016-01-22 10:59:02 +0100
committerHakim El Hattab <hakim.elhattab@gmail.com>2016-01-22 10:59:02 +0100
commitfc1c239743240350a1d0a029fa800c8bcdca37bb (patch)
tree24234ff7e24a21a2a5d5fd96e5108160a37029a3
parent8a40bb481e376539f7a307c0fffcf2da4e87cbeb (diff)
downloadfreenode-live-2017-presentation-fc1c239743240350a1d0a029fa800c8bcdca37bb.tar
freenode-live-2017-presentation-fc1c239743240350a1d0a029fa800c8bcdca37bb.tar.gz
add barebones example to readme
-rw-r--r--README.md24
1 files changed, 23 insertions, 1 deletions
diff --git a/README.md b/README.md
index c406960..accb4fe 100644
--- a/README.md
+++ b/README.md
@@ -21,7 +21,29 @@ Presentations are written using HTML or Markdown but there's also an online edit
### Markup
-Markup hierarchy needs to be ``<div class="reveal"> <div class="slides"> <section>`` where the ``<section>`` represents one slide and can be repeated indefinitely. If you place multiple ``<section>``'s inside of another ``<section>`` they will be shown as vertical slides. The first of the vertical slides is the "root" of the others (at the top), and it will be included in the horizontal sequence. For example:
+Here's a barebones example of a fully working reveal.js presentation:
+```html
+<html>
+ <head>
+ <link rel="stylesheet" href="css/reveal.css">
+ <link rel="stylesheet" href="css/theme/white.css">
+ </head>
+ <body>
+ <div class="reveal">
+ <div class="slides">
+ <section>Slide 1</section>
+ <section>Slide 2</section>
+ </div>
+ </div>
+ <script src="js/reveal.js"></script>
+ <script>
+ Reveal.initialize();
+ </script>
+ </body>
+</html>
+```
+
+Markup hierarchy needs to be `.reveal > .slides > section` where the `section` represents one slide and can be repeated indefinitely. If you place multiple `section`'s inside of another `section` they will be shown as vertical slides. The first of the vertical slides is the "root" of the others (at the top), and will be included in the horizontal sequence. For example:
```html
<div class="reveal">