README.md

   1 # reveal.js
   2
   3 A framework for easily creating beautiful presentations using HTML. [Check out the live demo](http://lab.hakim.se/reveal-js/).
   4
   5 reveal.js comes with a broad range of features including [nested slides](https://github.com/hakimel/reveal.js#markup), [markdown contents](https://github.com/hakimel/reveal.js#markdown), [PDF export](https://github.com/hakimel/reveal.js#pdf-export), [speaker notes](https://github.com/hakimel/reveal.js#speaker-notes) and a [JavaScript API](https://github.com/hakimel/reveal.js#api). It's best viewed in a browser with support for CSS 3D transforms but [fallbacks](https://github.com/hakimel/reveal.js/wiki/Browser-Support) are available to make sure your presentation can still be viewed elsewhere.
   6
   7
   8 #### More reading in the Wiki:
   9 - [Changelog](https://github.com/hakimel/reveal.js/wiki/Changelog): Up-to-date version history.
  10 - [Examples](https://github.com/hakimel/reveal.js/wiki/Example-Presentations): Presentations created with reveal.js, add your own!
  11 - [Browser Support](https://github.com/hakimel/reveal.js/wiki/Browser-Support): Explanation of browser support and fallbacks.
  12
  13 ## rvl.io
  14
  15 Slides are written using HTML or markdown but there's also an online editor for those of you who prefer a more traditional user interface. Give it a try at [www.rvl.io](http://www.rvl.io).
  16
  17
  18 ## Instructions
  19
  20 ### Markup
  21
  22 Markup heirarchy 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:
  23
  24 ```html
  25 <div class="reveal">
  26         <div class="slides">
  27                 <section>Single Horizontal Slide</section>
  28                 <section>
  29                         <section>Vertical Slide 1</section>
  30                         <section>Vertical Slide 2</section>
  31                 </section>
  32         </div>
  33 </div>
  34 ```
  35
  36 ### Markdown
  37
  38 It's possible to write your slides using Markdown. To enable Markdown, add the ```data-markdown``` attribute to your ```<section>``` elements and wrap the contents in a ```<script type="text/template">``` like the example below.
  39
  40 This is based on [data-markdown](https://gist.github.com/1343518) from [Paul Irish](https://github.com/paulirish) which in turn uses [showdown](https://github.com/coreyti/showdown/). This is sensitive to indentation (avoid mixing tabs and spaces) and line breaks (avoid consecutive breaks).
  41
  42 ```html
  43 <section data-markdown>
  44         <script type="text/template">
  45                 ## Page title
  46
  47                 A paragraph with some text and a [link](http://hakim.se).
  48         </script>
  49 </section>
  50 ```
  51
  52
  53 ### Configuration
  54
  55 At the end of your page you need to initialize reveal by running the following code. Note that all config values are optional and will default as specified below.
  56
  57 ```javascript
  58 Reveal.initialize({
  59         // Display controls in the bottom right corner
  60         controls: true,
  61
  62         // Display a presentation progress bar
  63         progress: true,
  64
  65         // Push each slide change to the browser history
  66         history: false,
  67
  68         // Enable keyboard shortcuts for navigation
  69         keyboard: true,
  70
  71         // Enable the slide overview mode
  72         overview: true,
  73
  74         // Loop the presentation
  75         loop: false,
  76
  77         // Number of milliseconds between automatically proceeding to the
  78         // next slide, disabled when set to 0, this value can be overwritten
  79         // by using a data-autoslide attribute on your slides
  80         autoSlide: 0,
  81
  82         // Enable slide navigation via mouse wheel
  83         mouseWheel: true,
  84
  85         // Apply a 3D roll to links on hover
  86         rollingLinks: true,
  87
  88         // Transition style
  89         transition: 'default' // default/cube/page/concave/zoom/linear/none
  90 });
  91 ```
  92
  93 ### Dependencies
  94
  95 Reveal.js doesn't _rely_ on any third party scripts to work but a few optional libraries are included by default. These libraries are loaded as dependencies in the order they appear, for example:
  96
  97 ```javascript
  98 Reveal.initialize({
  99         dependencies: [
 100                 // Syntax highlight for <code> elements
 101                 { src: 'lib/js/highlight.js', async: true, callback: function() { window.hljs.initHighlightingOnLoad(); } },
 102                 // Cross-browser shim that fully implements classList - https://github.com/eligrey/classList.js/
 103                 { src: 'lib/js/classList.js', condition: function() { return !document.body.classList; } }
 104                 // Interpret Markdown in <section> elements
 105                 { src: 'lib/js/data-markdown.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } },
 106                 { src: 'lib/js/showdown.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } },
 107                 // Zoom in and out with Alt+click
 108                 { src: 'plugin/zoom-js/zoom.js', async: true, condition: function() { return !!document.body.classList; } },
 109                 // Speaker notes
 110                 { src: 'plugin/notes/notes.js', async: true, condition: function() { return !!document.body.classList; } }
 111         ]
 112 });
 113 ```
 114
 115 You can add your own extensions using the same syntax. The following properties are available for each dependency object:
 116 - **src**: Path to the script to load
 117 - **async**: [optional] Flags if the script should load after reveal.js has started, defaults to false
 118 - **callback**: [optional] Function to execute when the script has loaded
 119 - **condition**: [optional] Function which must return true for the script to be loaded
 120
 121
 122 ### API
 123
 124 The Reveal class provides a minimal JavaScript API for controlling navigation and reading state:
 125
 126 ```javascript
 127 // Navigation
 128 Reveal.slide( indexh, indexv );
 129 Reveal.left();
 130 Reveal.right();
 131 Reveal.up();
 132 Reveal.down();
 133 Reveal.prev();
 134 Reveal.next();
 135 Reveal.prevFragment();
 136 Reveal.nextFragment();
 137 Reveal.toggleOverview();
 138
 139 // Retrieves the previous and current slide elements
 140 Reveal.getPreviousSlide();
 141 Reveal.getCurrentSlide();
 142
 143 Reveal.getIndices(); // { h: 0, v: 0 } }
 144 ```
 145
 146 ### States
 147
 148 If you set ``data-state="somestate"`` on a slide ``<section>``, "somestate" will be applied as a class on the document element when that slide is opened. This allows you to apply broad style changes to the page based on the active slide.
 149
 150 Furthermore you can also listen to these changes in state via JavaScript:
 151
 152 ```javascript
 153 Reveal.addEventListener( 'somestate', function() {
 154         // TODO: Sprinkle magic
 155 }, false );
 156 ```
 157
 158 ### Ready event
 159
 160 The 'ready' event is fired when reveal.js has loaded all (synchronous) dependencies and is ready to start navigating.
 161
 162 ```javascript
 163 Reveal.addEventListener( 'ready', function( event ) {
 164         // event.currentSlide, event.indexh, event.indexv
 165 } );
 166 ```
 167
 168 ### Slide change event
 169
 170 An 'slidechanged' event is fired each time the slide is changed (regardless of state). The event object holds the index values of the current slide as well as a reference to the previous and current slide HTML nodes.
 171
 172 ```javascript
 173 Reveal.addEventListener( 'slidechanged', function( event ) {
 174         // event.previousSlide, event.currentSlide, event.indexh, event.indexv
 175 } );
 176 ```
 177
 178 ### Internal links
 179
 180 It's easy to link between slides. The first example below targets the index of another slide whereas the second targets a slide with an ID attribute (```<section id="some-slide">```):
 181
 182 ```html
 183 <a href="#/2/2">Link</a>
 184 <a href="#/some-slide">Link</a>
 185 ```
 186 ### Fullscreen mode
 187 Just press »F« on your keyboard to show your presentation in fullscreen mode. Press the »ESC« key to exit fullscreen mode.
 188
 189 ### Fragments
 190 Fragments are used to highlight individual elements on a slide. Every elmement with the class ```fragment``` will be stepped through before moving on to the next slide. Here's an example: http://lab.hakim.se/reveal-js/#/16
 191
 192 The default fragment style is to start out invisible and fade in. This style can be changed by appending a different class to the fragment:
 193
 194 ```html
 195 <section>
 196         <p class="fragment grow">grow</p>
 197         <p class="fragment shrink">shrink</p>
 198         <p class="fragment roll-in">roll-in</p>
 199         <p class="fragment fade-out">fade-out</p>
 200         <p class="fragment highlight-red">highlight-red</p>
 201         <p class="fragment highlight-green">highlight-green</p>
 202         <p class="fragment highlight-blue">highlight-blue</p>
 203 </section>
 204 ```
 205
 206 ### Fragment events
 207
 208 When a slide fragment is either shown or hidden reveal.js will dispatch an event.
 209
 210 ```javascript
 211 Reveal.addEventListener( 'fragmentshown', function( event ) {
 212         // event.fragment = the fragment DOM element
 213 } );
 214 Reveal.addEventListener( 'fragmenthidden', function( event ) {
 215         // event.fragment = the fragment DOM element
 216 } );
 217 ```
 218
 219
 220 ## PDF Export
 221
 222 Presentations can be exported to PDF via a special print stylesheet. This feature requires that you use [Google Chrome](http://google.com/chrome).
 223 Here's an example of an exported presentation that's been uploaded to SlideShare: http://www.slideshare.net/hakimel/revealjs-13872948.
 224
 225 1. Open your presentation with [css/print/pdf.css](https://github.com/hakimel/reveal.js/blob/master/css/print/pdf.css) included on the page. The default index HTML lets you add *print-pdf* anywhere in the query to include the stylesheet, for example: [lab.hakim.se/reveal-js?print-pdf](http://lab.hakim.se/reveal-js?print-pdf).
 226 2. Open the in-browser print dialog (CMD+P).
 227 3. Change the **Destination** setting to **Save as PDF**.
 228 4. Change the **Layout** to **Landscape**.
 229 5. Change the **Margins** to **None**.
 230 6. Click **Save**.
 231
 232 ![Chrome Print Settings](https://s3.amazonaws.com/hakim-static/reveal-js/pdf-print-settings.png)
 233
 234
 235 ## Speaker Notes
 236
 237 reveal.js comes with a speaker notes plugin which can be used to present per-slide notes in a separate browser window. The notes window also gives you a preview of the next upcoming slide so it may be helpful even if you haven't written any notes. Append ```?notes``` to presentation URL or press the 's' key on your keyboard to open the notes window.
 238
 239 Notes are written using the following markup structure:
 240
 241 ```html
 242 <section>
 243         <h2>Some Slide</h2>
 244
 245         <aside class="notes">
 246                 Oh hey, these are some notes. They'll be hidden in your presentation, but you can see them if you open the speaker notes window (hit 's' on your keyboard).
 247         </aside>
 248 </section>
 249 ```
 250
 251
 252 ## Folder Structure
 253 - **css/** Core styles without which the project does not function
 254 - **js/** Like above but for JavaScript
 255 - **plugin/** Components that have been developed as extensions to reveal.js
 256 - **lib/** All other third party assets (JavaScript, CSS, fonts)
 257
 258 ## License
 259
 260 MIT licensed
 261
 262 Copyright (C) 2011-2012 Hakim El Hattab, http://hakim.se
 263