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                 // Speaker notes support
 108                 { src: 'plugin/speakernotes/client.js', async: true, condition: function() { return window.location.host === 'localhost:1947'; } },
 109                 { src: '/socket.io/socket.io.js', async: true, condition: function() { return window.location.host === 'localhost:1947'; } },
 110         ]
 111 });
 112 ```
 113
 114 You can add your own extensions using the same syntax. The following properties are available for each dependency object:
 115 - **src**: Path to the script to load
 116 - **async**: [optional] Flags if the script should load after reveal.js has started, defaults to false
 117 - **callback**: [optional] Function to execute when the script has loaded
 118 - **condition**: [optional] Function which must return true for the script to be loaded
 119
 120
 121 ### API
 122
 123 The Reveal class provides a minimal JavaScript API for controlling navigation and reading state:
 124
 125 ```javascript
 126 // Navigation
 127 Reveal.navigateTo( indexh, indexv );
 128 Reveal.navigateLeft();
 129 Reveal.navigateRight();
 130 Reveal.navigateUp();
 131 Reveal.navigateDown();
 132 Reveal.navigatePrev();
 133 Reveal.navigateNext();
 134 Reveal.toggleOverview();
 135
 136 // Retrieves the previous and current slide elements
 137 Reveal.getPreviousSlide();
 138 Reveal.getCurrentSlide();
 139
 140 Reveal.getIndices(); // { h: 0, v: 0 } }
 141 ```
 142
 143 ### States
 144
 145 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.
 146
 147 Furthermore you can also listen to these changes in state via JavaScript:
 148
 149 ```javascript
 150 Reveal.addEventListener( 'somestate', function() {
 151         // TODO: Sprinkle magic
 152 }, false );
 153 ```
 154
 155 ### Slide change event
 156
 157 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.
 158
 159 ```javascript
 160 Reveal.addEventListener( 'slidechanged', function( event ) {
 161         // event.previousSlide, event.currentSlide, event.indexh, event.indexv
 162 } );
 163 ```
 164
 165 ### Fragment events
 166
 167 When a slide fragment is either shown or hidden reveal.js will dispatch an event.
 168
 169 ```javascript
 170 Reveal.addEventListener( 'fragmentshown', function( event ) {
 171         // event.fragment = the fragment DOM element
 172 } );
 173 Reveal.addEventListener( 'fragmenthidden', function( event ) {
 174         // event.fragment = the fragment DOM element
 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
 187 ## PDF Export
 188
 189 Presentations can be exported to PDF via a special print stylesheet. This feature requires that you use [Google Chrome](http://google.com/chrome).
 190 Here's an example of an exported presentation that's been uploaded to SlideShare: http://www.slideshare.net/hakimel/revealjs-13872948.
 191
 192 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).
 193 2. Open the in-browser print dialog (CMD+P).
 194 3. Change the **Destination** setting to **Save as PDF**.
 195 4. Change the **Layout** to **Landscape**.
 196 5. Change the **Margins** to **None**.
 197 6. Click **Save**.
 198
 199 ![Chrome Print Settings](https://s3.amazonaws.com/hakim-static/reveal-js/pdf-print-settings.png)
 200
 201 ## Speaker Notes
 202
 203 If you're interested in using speaker notes, reveal.js comes with a Node server that allows you to deliver your presentation in one browser while viewing speaker notes in another.
 204
 205 To include speaker notes in your presentation, simply add an `<aside class="notes">` element to any slide. These notes will be hidden in the main presentation view.
 206
 207 It's also possible to write your notes with Markdown. To enable Markdown, add the ```data-markdown``` attribute to your note ```<aside>``` elements.
 208
 209 You'll also need to [install Node.js](http://nodejs.org/); then, install the server dependencies by running `npm install`.
 210
 211 Once Node.js and the dependencies are installed, run the following command from the root directory:
 212
 213                 node plugin/speakernotes
 214
 215 By default, the slides will be served at [localhost:1947](http://localhost:1947).
 216
 217 You can change the appearance of the speaker notes by editing the file at `plugin/speakernotes/notes.html`.
 218
 219 ### Known Issues
 220
 221 - The notes page is supposed to show the current slide and the next slide, but when it first starts, it always shows the first slide in both positions.
 222
 223 ## Folder Structure
 224 - **css/** Core styles without which the project does not function
 225 - **js/** Like above but for JavaScript
 226 - **plugin/** Components that have been developed as extensions to reveal.js
 227 - **lib/** All other third party assets (JavaScript, CSS, fonts)
 228
 229 ## License
 230
 231 MIT licensed
 232
 233 Copyright (C) 2011-2012 Hakim El Hattab, http://hakim.se