From 296a65a3e44077648d23fb64591de3467932c163 Mon Sep 17 00:00:00 2001 From: Hakim El Hattab Date: Wed, 24 Jul 2013 20:27:54 -0700 Subject: [PATCH] Create gh-pages branch via GitHub --- index.html | 451 ++++++++++++++++++++++++++++++++++++++++------------ params.json | 2 +- 2 files changed, 353 insertions(+), 100 deletions(-) diff --git a/index.html b/index.html index ca094d7..d546a76 100644 --- a/index.html +++ b/index.html @@ -28,31 +28,38 @@
-

reveal.js Build Status +

+reveal.js Build Status

A framework for easily creating beautiful presentations using HTML. Check out the live demo.

reveal.js comes with a broad range of features including nested slides, markdown contents, PDF export, speaker notes and a JavaScript API. It's best viewed in a browser with support for CSS 3D transforms but fallbacks are available to make sure your presentation can still be viewed elsewhere.

-

More reading in the Wiki:

+

+More reading:

rvl.io

+

+Slides

-

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.

+

Presentations are written using HTML or markdown but there's also an online editor for those of you who prefer a graphical interface. Give it a try at http://slid.es.

-

Instructions

+

+Instructions

-

Markup

+

+Markup

-

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:

+

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:

<div class="reveal">
     <div class="slides">
@@ -65,11 +72,12 @@
 </div>
-

Markdown

+

+Markdown

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.

-

This is based on data-markdown from Paul Irish which in turn uses showdown. Sensitive to indentation (avoid mixing tabs and spaces) and line breaks (avoid consecutive breaks).

+

This is based on data-markdown from Paul Irish modified to use marked to support Github Flavoured Markdown. Sensitive to indentation (avoid mixing tabs and spaces) and line breaks (avoid consecutive breaks).

<section data-markdown>
     <script type="text/template">
@@ -80,14 +88,16 @@
 </section>
-

External Markdown

+

+External Markdown

You can write your content as a separate file and have reveal.js load it at runtime. Note the separator arguments which determine how slides are delimited in the external file.

<section data-markdown="example.md" data-separator="^\n\n\n" data-vertical="^\n\n"></section>
-

Configuration

+

+Configuration

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.

@@ -105,6 +115,9 @@ // Enable keyboard shortcuts for navigation keyboard: true, + // Enable touch events for navigation + touch: true, + // Enable the slide overview mode overview: true, @@ -117,7 +130,7 @@ // Change the presentation direction to be RTL rtl: false, - // Number of milliseconds between automatically proceeding to the + // Number of milliseconds between automatically proceeding to the // next slide, disabled when set to 0, this value can be overwritten // by using a data-autoslide attribute on your slides autoSlide: 0, @@ -129,7 +142,13 @@ rollingLinks: true, // Transition style - transition: 'default' // default/cube/page/concave/zoom/linear/fade/none + transition: 'default', // default/cube/page/concave/zoom/linear/fade/none + + // Transition speed + transitionSpeed: 'default', // default/fast/slow + + // Transition style for full page backgrounds + backgroundTransition: 'default' // default/linear }); @@ -145,33 +164,8 @@ Reveal.configure({ autoSlide: 5000 }); -

Presentation Size

- -

All presentations have a normal size, that is the resolution at which they are authored. The framework will automatically scale presentations uniformly based on this size to ensure that everything fits on any given display or viewport.

- -

See below for a list of configuration options related to sizing, including default values:

- -
Reveal.initialize({
-
-    ...
-
-    // The "normal" size of the presentation, aspect ratio will be preserved
-    // when the presentation is scaled to fit different resolutions. Can be
-    // specified using percentage units.
-    width: 960,
-    height: 700,
-
-    // Factor of the display size that should remain empty around the content
-    margin: 0.1,
-
-    // Bounds for smallest/largest possible scale to apply to content
-    minScale: 0.2,
-    maxScale: 1.0
-
-});
-
- -

Dependencies

+

+Dependencies

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:

@@ -181,7 +175,7 @@ { src: 'lib/js/classList.js', condition: function() { return !document.body.classList; } }, // Interpret Markdown in <section> elements - { src: 'plugin/markdown/showdown.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } }, + { src: 'plugin/markdown/marked.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } }, { src: 'plugin/markdown/markdown.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } }, // Syntax highlight for <code> elements @@ -210,9 +204,51 @@ callback: [optional] Function to execute when the script has loaded
  • condition: [optional] Function which must return true for the script to be loaded
    • -

    API

    +

    +Presentation Size

    + +

    All presentations have a normal size, that is the resolution at which they are authored. The framework will automatically scale presentations uniformly based on this size to ensure that everything fits on any given display or viewport.

    + +

    See below for a list of configuration options related to sizing, including default values:

    + +
    Reveal.initialize({
+
+    ...
+
+    // The "normal" size of the presentation, aspect ratio will be preserved
+    // when the presentation is scaled to fit different resolutions. Can be
+    // specified using percentage units.
+    width: 960,
+    height: 700,
+
+    // Factor of the display size that should remain empty around the content
+    margin: 0.1,
 
-
    The Reveal class provides a minimal JavaScript API for controlling navigation and reading state:
    
+    // Bounds for smallest/largest possible scale to apply to content
+    minScale: 0.2,
+    maxScale: 1.0
+
+});
+
    + +

    +Keyboard Bindings

    + +

    If you're unhappy with any of the default keyboard bindings you can override them using the keyboard config option:

    + +
    Reveal.configure({
+  keyboard: {
+    13: 'next', // go to the next slide when the ENTER key is pressed
+    27: function() {}, // do something custom when ESC is pressed
+    32: null // don't do anything when SPACE is pressed (i.e. disable a reveal.js default binding)
+  }
+});
+
    + +

    +API

    + +

    The Reveal class provides a JavaScript API for controlling navigation and reading state:

    // Navigation
 Reveal.slide( indexh, indexv, indexf );
@@ -225,26 +261,23 @@
 Reveal.prevFragment();
 Reveal.nextFragment();
 Reveal.toggleOverview();
+Reveal.togglePause();
 
 // Retrieves the previous and current slide elements
 Reveal.getPreviousSlide();
 Reveal.getCurrentSlide();
 
 Reveal.getIndices(); // { h: 0, v: 0 } }
-
    - -

    States

    - -

    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.

    - -

    Furthermore you can also listen to these changes in state via JavaScript:

    -
    Reveal.addEventListener( 'somestate', function() {
-    // TODO: Sprinkle magic
-}, false );
+// State checks
+Reveal.isFirstSlide();
+Reveal.isLastSlide();
+Reveal.isOverview();
+Reveal.isPaused();
    -

    Ready event

    +

    +Ready Event

    The 'ready' event is fired when reveal.js has loaded all (synchronous) dependencies and is ready to start navigating.

    @@ -253,7 +286,8 @@ } ); -

    Slide change event

    +

    +Slide Changed Event

    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.

    @@ -264,7 +298,54 @@ } ); -

    Internal links

    +

    +States

    + +

    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.

    + +

    Furthermore you can also listen to these changes in state via JavaScript:

    + +
    Reveal.addEventListener( 'somestate', function() {
+    // TODO: Sprinkle magic
+}, false );
+
    + +

    +Slide Backgrounds

    + +

    Slides are contained within a limited portion of the screen by default to allow them to fit any display and scale uniformly. You can apply full page background colors or images by applying a data-background attribute to your <section> elements. Below are a few examples.

    + +
    <section data-background="#ff0000">
+    <h2>All CSS color formats are supported, like rgba() or hsl().</h2>
+</section>
+<section data-background="http://example.com/image.png">
+    <h2>This slide will have a full-size background image.</h2>
+</section>
+<section data-background="http://example.com/image.png" data-background-size="100px" data-background-repeat="repeat">
+    <h2>This background image will be sized to 100px and repeated.</h2>
+</section>
+
    + +

    Backgrounds transition using a fade animation by default. This can be changed to a linear sliding transition by passing backgroundTransition: 'slide' to the Reveal.initialize() call. Alternatively you can set data-background-transition on any section with a background to override that specific transition.

    + +

    +Slide Transitions

    + +

    The global presentation transition is set using the transition config value. You can override the global transition for a specific slide by using the data-transition attribute:

    + +
    <section data-transition="zoom">
+    <h2>This slide will override the presentation transition and zoom!</h2>
+</section>
+
+<section data-transition-speed="fast">
+    <h2>Choose from three transition speeds: default, fast or slow!</h2>
+</section>
+
    + +

    Note that this does not work with the page and cube transitions.

    + +

    +Internal links

    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">):

    @@ -282,9 +363,10 @@ <a href="#" class="navigate-next"> <!-- Next vertical or horizontal slide --> -

    Fragments

    +

    +Fragments

    -

    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

    +

    Fragments are used to highlight individual elements on a slide. Every element 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

    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:

    @@ -317,7 +399,8 @@ </section> -

    Fragment events

    +

    +Fragment events

    When a slide fragment is either shown or hidden reveal.js will dispatch an event.

    @@ -329,12 +412,13 @@ } ); -

    Code syntax highlighting

    +

    +Code syntax highlighting

    -

    By default, Reveal is configured with highlight.js for code syntax highlighting. Below is an example with clojure code that will be syntax highlighted:

    +

    By default, Reveal is configured with highlight.js for code syntax highlighting. Below is an example with clojure code that will be syntax highlighted. When the data-trim attribute is present surrounding whitespace is automatically removed.

    <section>
-    <pre><code>
+    <pre><code data-trim>
 (def lazy-fib
   (concat
    [0 1]
@@ -344,7 +428,8 @@
 </section>
    -

    Overview mode

    +

    +Overview mode

    Press "Esc" key to toggle the overview mode on and off. While you're in this mode, you can still navigate between slides, as if you were at 1,000 feet above your presentation. The overview mode comes with a few API hooks:

    @@ -356,13 +441,25 @@ as if you were at 1,000 feet above your presentation. The overview mode comes wi Reveal.toggleOverview(); -

    Fullscreen mode

    +

    +Fullscreen mode

    Just press »F« on your keyboard to show your presentation in fullscreen mode. Press the »ESC« key to exit fullscreen mode.

    -

    PDF Export

    +

    +Embedded media

    + +

    Embedded HTML5 <video>/<audio> and YouTube iframes are automatically paused when your navigate away from a slide. This can be disabled by decorating your element with a data-ignore attribute.

    + +

    Add data-autoplay to your media element if you want it to automatically start playing when the slide is shown:

    + +
    <video data-autoplay src="http://clips.vorwaerts-gmbh.de/big_buck_bunny.mp4"></video>
+
    + +

    +PDF Export

    -

    Presentations can be exported to PDF via a special print stylesheet. This feature requires that you use Google Chrome. +

    Presentations can be exported to PDF via a special print stylesheet. This feature requires that you use Google Chrome. Here's an example of an exported presentation that's been uploaded to SlideShare: http://www.slideshare.net/hakimel/revealjs-13872948.

      @@ -374,9 +471,29 @@ Here's an example of an exported presentation that's been uploaded to SlideShare
    1. Click Save.

    Chrome Print Settings

    -

    Speaker Notes

    +

    +Theming

    + +

    The framework comes with a few different themes included:

    + +

    Each theme is available as a separate stylesheet. To change theme you will need to replace default below with your desired theme name in index.html:

    + +
    <link rel="stylesheet" href="css/theme/default.css" id="theme">
+
    + +

    If you want to add a theme of your own see the instructions here: /css/theme/README.md.

    + +

    +Speaker Notes

    -

    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 the presentation URL or press the 's' key on your keyboard to open the notes window.

    +

    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. Press the 's' key on your keyboard to open the notes window.

    By default notes are written using standard HTML, see below, but you can add a data-markdown attribute to the <aside> to write them using Markdown.

    @@ -389,7 +506,8 @@ Here's an example of an exported presentation that's been uploaded to SlideShare </section> -

    Server Side Speaker Notes

    +

    +Server Side Speaker Notes

    In some cases it can be desirable to run notes on a separate device from the one you're presenting on. The Node.js-based notes plugin lets you do this using the same note definitions as its client side counterpart. Include the required scripts by adding the following dependencies:

    @@ -412,59 +530,193 @@ Here's an example of an exported presentation that's been uploaded to SlideShare
  • Run node plugin/notes-server
    • -

    Multiplexing

    +

    +Multiplexing

    + +

    The multiplex plugin allows your audience to view the slides of the presentation you are controlling on their own phone, tablet or laptop. As the master presentation navigates the slides, all client presentations will update in real time. See a demo at http://revealjs.jit.su/.

    + +

    The multiplex plugin needs the following 3 things to operate:

    + +
      +
    1. Master presentation that has control
      2. +
    2. Client presentations that follow the master
      3. +
    3. Socket.io server to broadcast events from the master to the clients
      4. +

    More details:

    + +

    +Master presentation

    -

    The multiplex plugin allows your audience to view the slides on their own phone, tablet or laptop. As the master navigates the slides, all clients will update in real time. See a demo at http://revealjs.jit.su/.

    +

    Served from a static file server accessible (preferably) only to the presenter. This need only be on your (the presenter's) computer. (It's safer to run the master presentation from your own computer, so if the venue's Internet goes down it doesn't stop the show.) An example would be to execute the following commands in the directory of your master presentation:

    -

    Configuration is via the multiplex object in Reveal.initialize. To generate unique secret and token values, visit revealjs.jit.su/token. Below is an example configuration with the multiplex plugin enabled:

    +
      +
    1. npm install node-static
      2. +
    2. static
      3. +

    If you want to use the speaker notes plugin with your master presentation then make sure you have the speaker notes plugin configured correctly along with the configuration shown below, then execute node plugin/notes-server in the directory of your master presentation. The configuration below will cause it to connect to the socket.io server as a master, as well as launch your speaker-notes/static-file server.

    + +

    You can then access your master presentation at http://localhost:1947

    + +

    Example configuration:

    Reveal.initialize({
-    ...
+    // other options
 
-    // Generate a unique id and secret at revealjs.jit.su/token
     multiplex: {
-        id: '',
-        secret: '',
-        url: 'revealjs.jit.su:80'
+        // Example values. Generate your own.
+        secret: '13652805320794272084', // Obtained from the socket.io server. Gives this (the master) control of the presentation
+        id: '1ea875674b17ca76', // Obtained from socket.io server
+        url: 'revealjs.jit.su:80' // Location of socket.io server
     },
 
+    // Optional libraries used to extend on reveal.js
     dependencies: [
-        { src: 'socket.io/socket.io.js', async: true },
-        { src: 'plugin/multiplex/client.js', async: true },
+        // other deps
+        { src: '//cdnjs.cloudflare.com/ajax/libs/socket.io/0.9.10/socket.io.min.js', async: true },
         { src: 'plugin/multiplex/master.js', async: true },
+
+        // and if you want speaker notes
+        { src: 'plugin/notes-server/client.js', async: true }
     ]
 });
    -

    multiplex.secret should only be configured on those pages you wish to be able to control slide navigation for all clients. Multi-master configurations work, but if you don't want your audience to be able to control your slides, set the secret to null. In this master/slave setup, you should create a publicly accessible page with secret set to null, and a protected page containing your secret.

    +

    +Client presentation

    -

    You are very welcome to use the server running at reveal.jit.su, however availability and stability are not guaranteed. For anything mission critical I recommend you run your own server. It is simple to deploy to nodejitsu or run on your own environment.

    +

    Served from a publicly accessible static file server. Examples include: GitHub Pages, Amazon S3, Dreamhost, Akamai, etc. The more reliable, the better. Your audience can then access the client presentation via http://example.com/path/to/presentation/client/index.html, with the configuration below causing them to connect to the socket.io server as clients.

    -

    Theming

    +

    Example configuration:

    -

    The framework comes with a few different themes included:

    +
    Reveal.initialize({
+    // other options
 
-
      
-
    • default: Gray background, white text, blue links
      • 
-
    • beige: Beige background, dark text, brown links
      • 
-
    • sky: Blue background, thin white text, blue links
      • 
-
    • night: Black background, thick white text, orange links
      • 
-
    • serif: Cappuccino background, gray text, brown links
      • 
-
    • simple: White background, black text, blue links
      • 
-
    Each theme is available as a separate stylesheet. To change theme you will need to replace default below with your desired theme name in index.html:
    
+    multiplex: {
+        // Example values. Generate your own.
+        secret: null, // null so the clients do not have control of the master presentation
+        id: '1ea875674b17ca76', // id, obtained from socket.io server
+        url: 'revealjs.jit.su:80' // Location of socket.io server
+    },
 
-
    <link rel="stylesheet" href="css/theme/default.css" id="theme">
+    // Optional libraries used to extend on reveal.js
+    dependencies: [
+        // other deps
+        { src: '//cdnjs.cloudflare.com/ajax/libs/socket.io/0.9.10/socket.io.min.js', async: true },
+        { src: 'plugin/multiplex/client.js', async: true }
+    ]
+});
 
    
 
-
    If you want to add a theme of your own see the instructions here: /css/theme/README.md.
    
+
    
+Socket.io server
    
 
-
    Development Environment
    
+
    Server that receives the slideChanged events from the master presentation and broadcasts them out to the connected client presentations. This needs to be publicly accessible. You can run your own socket.io server with the commands:
    
 
-
    reveal.js is built using the task-based command line build tool grunt.js (installation instructions). With Node.js and grunt.js installed, you need to start by running npm install in the reveal.js root. When the dependencies have been installed you should run grunt watch to start monitoring files for changes.
    
+
      
+
    1. npm install
      2. 
+
    2. node plugin/multiplex
      3. 
+
    Or you use the socket.io server at http://revealjs.jit.su.
    
+
+
    You'll need to generate a unique secret and token pair for your master and client presentations. To do so, visit http://example.com/token, where http://example.com is the location of your socket.io server. Or if you're going to use the socket.io server at http://revealjs.jit.su, visit http://revealjs.jit.su/token.
    
+
+
    You are very welcome to point your presentations at the Socket.io server running at http://revealjs.jit.su, but availability and stability are not guaranteed. For anything mission critical I recommend you run your own server. It is simple to deploy to nodejitsu, heroku, your own environment, etc.
    
+
+
    
+socket.io server as file static server
    
+
+
    The socket.io server can play the role of static file server for your client presentation, as in the example at http://revealjs.jit.su. (Open http://revealjs.jit.su in two browsers. Navigate through the slides on one, and the other will update to match.) 
    
+
+
    Example configuration:
    
+
+
    Reveal.initialize({
+    // other options
+
+    multiplex: {
+        // Example values. Generate your own.
+        secret: null, // null so the clients do not have control of the master presentation
+        id: '1ea875674b17ca76', // id, obtained from socket.io server
+        url: 'example.com:80' // Location of your socket.io server
+    },
+
+    // Optional libraries used to extend on reveal.js
+    dependencies: [
+        // other deps
+        { src: '//cdnjs.cloudflare.com/ajax/libs/socket.io/0.9.10/socket.io.min.js', async: true },
+        { src: 'plugin/multiplex/client.js', async: true }
+    ]
+
    
+
+
    It can also play the role of static file server for your master presentation and client presentations at the same time (as long as you don't want to use speaker notes). (Open http://revealjs.jit.su in two browsers. Navigate through the slides on one, and the other will update to match. Navigate through the slides on the second, and the first will update to match.) This is probably not desirable, because you don't want your audience to mess with your slides while you're presenting. ;)
    
+
+
    Example configuration:
    
+
+
    Reveal.initialize({
+    // other options
 
-
    If you want to customise reveal.js without running grunt.js you can alter the HTML to point to the uncompressed source files (css/reveal.css & js/reveal.js).
    
+    multiplex: {
+        // Example values. Generate your own.
+        secret: '13652805320794272084', // Obtained from the socket.io server. Gives this (the master) control of the presentation
+        id: '1ea875674b17ca76', // Obtained from socket.io server
+        url: 'example.com:80' // Location of your socket.io server
+    },
 
-
    Folder Structure
    
+    // Optional libraries used to extend on reveal.js
+    dependencies: [
+        // other deps
+        { src: '//cdnjs.cloudflare.com/ajax/libs/socket.io/0.9.10/socket.io.min.js', async: true },
+        { src: 'plugin/multiplex/master.js', async: true },
+        { src: 'plugin/multiplex/client.js', async: true }
+    ]
+});
+
    
+
+
    
+Installation
    
+
+
    The basic setup is for authoring presentations only. The full setup gives you access to all reveal.js features as well as the development tasks needed to make changes to the source.
    
+
+
    
+Basic setup
    
+
+
    The core of reveal.js is very easy to install. You'll simply need to download a copy of this repository and open the index.html file directly in your browser.
    
+
+
      
+
    1. Download the latest version of reveal.js from https://github.com/hakimel/reveal.js/releases
      2. 
+
    2. Unzip and replace the example contents in index.html with your own
      3. 
+
    3. Open index.html in a browser to view it
      4. 
+
    
+Full setup
    
+
+
    Some reveal.js features, like external markdown, require that presentations run from a local web server. The following instructions will set up such a server as well as all of the development tasks needed to make edits to the reveal.js source code.
    
+
+
      
+
    1. Install Node.js
      2. 
+
    2. Install Grunt
      3. 
+
    3. 
+
      Clone the reveal.js repository  
      
+
+
      $ git clone git@github.com:hakimel/reveal.js.git
+
      
+
      4. 
+
    4. 
+
      Navigate to the reveal.js folder 
      
+
+
      $ cd reveal.js
+
      
+
      5. 
+
    5. 
+
      Install dependencies  
      
+
+
      $ npm install
+
      
+
      6. 
+
    6. 
+
      Serve the presentation and monitor source files for changes  
      
+
+
      $ grunt serve
+
      
+
      7. 
+
    7. Open http://localhost:8000 to view your presentation
      8. 
+
    
+Folder Structure
    
 
 
      
 
    • 
@@ -475,7 +727,8 @@ Here's an example of an exported presentation that's been uploaded to SlideShare
 plugin/ Components that have been developed as extensions to reveal.js
      • 
 
    • 
 lib/ All other third party assets (JavaScript, CSS, fonts)
      • 
-
    License
    
+
    
+License
    
 
 
    MIT licensed
    
 
diff --git a/params.json b/params.json
index 4769499..1f7704f 100644
--- a/params.json
+++ b/params.json
@@ -1 +1 @@
-{"name":"reveal.js","tagline":"The HTML Presentation Framework","body":"# reveal.js [![Build Status](https://travis-ci.org/hakimel/reveal.js.png?branch=master)](https://travis-ci.org/hakimel/reveal.js)\r\n\r\nA framework for easily creating beautiful presentations using HTML. [Check out the live demo](http://lab.hakim.se/reveal-js/).\r\n\r\nreveal.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.\r\n\r\n\r\n#### More reading in the Wiki:\r\n- [Changelog](https://github.com/hakimel/reveal.js/wiki/Changelog): Up-to-date version history.\r\n- [Examples](https://github.com/hakimel/reveal.js/wiki/Example-Presentations): Presentations created with reveal.js, add your own!\r\n- [Browser Support](https://github.com/hakimel/reveal.js/wiki/Browser-Support): Explanation of browser support and fallbacks.\r\n\r\n## rvl.io\r\n\r\nSlides 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).\r\n\r\n\r\n## Instructions\r\n\r\n### Markup\r\n\r\nMarkup heirarchy needs to be ``
     
     
    `` where the ``
    `` represents one slide and can be repeated indefinitely. If you place multiple ``
    ``'s inside of another ``
    `` 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:\r\n\r\n```html\r\n
    \r\n\t
    \r\n\t\t
    Single Horizontal Slide
    \r\n\t\t
    \r\n\t\t\t
    Vertical Slide 1
    \r\n\t\t\t
    Vertical Slide 2
    \r\n\t\t
    \r\n\t
    \r\n
    \r\n```\r\n\r\n### Markdown\r\n\r\nIt's possible to write your slides using Markdown. To enable Markdown, add the ```data-markdown``` attribute to your ```
    ``` elements and wrap the contents in a ```\r\n
    \r\n```\r\n\r\n#### External Markdown\r\n\r\nYou can write your content as a separate file and have reveal.js load it at runtime. Note the separator arguments which determine how slides are delimited in the external file.\r\n\r\n```html\r\n
    \r\n```\r\n\r\n### Configuration\r\n\r\nAt 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.\r\n\r\n```javascript\r\nReveal.initialize({\r\n\r\n\t// Display controls in the bottom right corner\r\n\tcontrols: true,\r\n\r\n\t// Display a presentation progress bar\r\n\tprogress: true,\r\n\r\n\t// Push each slide change to the browser history\r\n\thistory: false,\r\n\r\n\t// Enable keyboard shortcuts for navigation\r\n\tkeyboard: true,\r\n\r\n\t// Enable the slide overview mode\r\n\toverview: true,\r\n\r\n\t// Vertical centering of slides\r\n\tcenter: true,\r\n\r\n\t// Loop the presentation\r\n\tloop: false,\r\n\r\n\t// Change the presentation direction to be RTL\r\n\trtl: false,\r\n\r\n\t// Number of milliseconds between automatically proceeding to the \r\n\t// next slide, disabled when set to 0, this value can be overwritten\r\n\t// by using a data-autoslide attribute on your slides\r\n\tautoSlide: 0,\r\n\r\n\t// Enable slide navigation via mouse wheel\r\n\tmouseWheel: false,\r\n\r\n\t// Apply a 3D roll to links on hover\r\n\trollingLinks: true,\r\n\r\n\t// Transition style\r\n\ttransition: 'default' // default/cube/page/concave/zoom/linear/fade/none\r\n\r\n});\r\n```\r\n\r\nNote that the new default vertical centering option will break compatibility with slides that were using transitions with backgrounds (`cube` and `page`). To restore the previous behavior, set `center` to `false`.\r\n\r\nThe configuration can be updated after initialization using the ```configure``` method:\r\n\r\n```javascript\r\n// Turn autoSlide off\r\nReveal.configure({ autoSlide: 0 });\r\n\r\n// Start auto-sliding every 5s\r\nReveal.configure({ autoSlide: 5000 });\r\n```\r\n\r\n\r\n### Presentation Size\r\n\r\nAll presentations have a normal size, that is the resolution at which they are authored. The framework will automatically scale presentations uniformly based on this size to ensure that everything fits on any given display or viewport. \r\n\r\nSee below for a list of configuration options related to sizing, including default values:\r\n\r\n```javascript\r\nReveal.initialize({\r\n\t\r\n\t...\r\n\t\r\n\t// The \"normal\" size of the presentation, aspect ratio will be preserved\r\n\t// when the presentation is scaled to fit different resolutions. Can be\r\n\t// specified using percentage units.\r\n\twidth: 960,\r\n\theight: 700,\r\n\t\r\n\t// Factor of the display size that should remain empty around the content\r\n\tmargin: 0.1,\r\n\t\r\n\t// Bounds for smallest/largest possible scale to apply to content\r\n\tminScale: 0.2,\r\n\tmaxScale: 1.0\r\n\t\r\n});\r\n```\r\n\r\n\r\n### Dependencies\r\n\r\nReveal.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:\r\n\r\n```javascript\r\nReveal.initialize({\r\n\tdependencies: [\r\n\t\t// Cross-browser shim that fully implements classList - https://github.com/eligrey/classList.js/\r\n\t\t{ src: 'lib/js/classList.js', condition: function() { return !document.body.classList; } },\r\n\r\n\t\t// Interpret Markdown in 
     elements\r\n\t\t{ src: 'plugin/markdown/showdown.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } },\r\n\t\t{ src: 'plugin/markdown/markdown.js', condition: function() { return !!document.querySelector( '[data-markdown]' ); } },\r\n\r\n\t\t// Syntax highlight for  elements\r\n\t\t{ src: 'plugin/highlight/highlight.js', async: true, callback: function() { hljs.initHighlightingOnLoad(); } },\r\n\r\n\t\t// Zoom in and out with Alt+click\r\n\t\t{ src: 'plugin/zoom-js/zoom.js', async: true, condition: function() { return !!document.body.classList; } },\r\n\r\n\t\t// Speaker notes\r\n\t\t{ src: 'plugin/notes/notes.js', async: true, condition: function() { return !!document.body.classList; } },\r\n\r\n\t\t// Remote control your reveal.js presentation using a touch device\r\n\t\t{ src: 'plugin/remotes/remotes.js', async: true, condition: function() { return !!document.body.classList; } }\r\n\t]\r\n});\r\n```\r\n\r\nYou can add your own extensions using the same syntax. The following properties are available for each dependency object:\r\n- **src**: Path to the script to load\r\n- **async**: [optional] Flags if the script should load after reveal.js has started, defaults to false\r\n- **callback**: [optional] Function to execute when the script has loaded\r\n- **condition**: [optional] Function which must return true for the script to be loaded\r\n\r\n\r\n### API\r\n\r\nThe ``Reveal`` class provides a minimal JavaScript API for controlling navigation and reading state:\r\n\r\n```javascript\r\n// Navigation\r\nReveal.slide( indexh, indexv, indexf );\r\nReveal.left();\r\nReveal.right();\r\nReveal.up();\r\nReveal.down();\r\nReveal.prev();\r\nReveal.next();\r\nReveal.prevFragment();\r\nReveal.nextFragment();\r\nReveal.toggleOverview();\r\n\r\n// Retrieves the previous and current slide elements\r\nReveal.getPreviousSlide();\r\nReveal.getCurrentSlide();\r\n\r\nReveal.getIndices(); // { h: 0, v: 0 } }\r\n```\r\n\r\n### States\r\n\r\nIf you set ``data-state=\"somestate\"`` on a slide ``
    ``, \"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.\r\n\r\nFurthermore you can also listen to these changes in state via JavaScript:\r\n\r\n```javascript\r\nReveal.addEventListener( 'somestate', function() {\r\n\t// TODO: Sprinkle magic\r\n}, false );\r\n```\r\n\r\n### Ready event\r\n\r\nThe 'ready' event is fired when reveal.js has loaded all (synchronous) dependencies and is ready to start navigating.\r\n\r\n```javascript\r\nReveal.addEventListener( 'ready', function( event ) {\r\n\t// event.currentSlide, event.indexh, event.indexv\r\n} );\r\n```\r\n\r\n### Slide change event\r\n\r\nAn '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.\r\n\r\nSome libraries, like MathJax (see [#226](https://github.com/hakimel/reveal.js/issues/226#issuecomment-10261609)), get confused by the transforms and display states of slides. Often times, this can be fixed by calling their update or render function from this callback.\r\n\r\n```javascript\r\nReveal.addEventListener( 'slidechanged', function( event ) {\r\n\t// event.previousSlide, event.currentSlide, event.indexh, event.indexv\r\n} );\r\n```\r\n\r\n### Internal links\r\n\r\nIt'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 (```
    ```):\r\n\r\n```html\r\nLink\r\nLink\r\n```\r\n\r\nYou can also add relative navigation links, similar to the built in reveal.js controls, by appending one of the following classes on any element. Note that each element is automatically given an ```enabled``` class when it's a valid navigation route based on the current slide.\r\n\r\n```html\r\n\r\n\r\n\r\n\r\n \r\n \r\n```\r\n\r\n\r\n### Fragments\r\nFragments 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\r\n\r\nThe default fragment style is to start out invisible and fade in. This style can be changed by appending a different class to the fragment:\r\n\r\n```html\r\n
    \r\n\t
    grow
    \r\n\t
    shrink
    \r\n\t
    roll-in
    \r\n\t
    fade-out
    \r\n\t
    highlight-red
    \r\n\t
    highlight-green
    \r\n\t
    highlight-blue
    \r\n
    \r\n```\r\n\r\nMultiple fragments can be applied to the same element sequentially by wrapping it, this will fade in the text on the first step and fade it back out on the second.\r\n\r\n```html\r\n
    \r\n\t\r\n\t\tI'll fade in, then out\r\n\t\r\n
    \r\n```\r\n\r\nThe display order of fragments can be controlled using the ```data-fragment-index``` attribute.\r\n\r\n```html\r\n
    \r\n\t
    Appears last
    \r\n\t
    Appears first
    \r\n\t
    Appears second
    \r\n
    \r\n```\r\n\r\n### Fragment events\r\n\r\nWhen a slide fragment is either shown or hidden reveal.js will dispatch an event.\r\n\r\n```javascript\r\nReveal.addEventListener( 'fragmentshown', function( event ) {\r\n\t// event.fragment = the fragment DOM element\r\n} );\r\nReveal.addEventListener( 'fragmenthidden', function( event ) {\r\n\t// event.fragment = the fragment DOM element\r\n} );\r\n```\r\n\r\n### Code syntax highlighting\r\n\r\nBy default, Reveal is configured with [highlight.js](http://softwaremaniacs.org/soft/highlight/en/) for code syntax highlighting. Below is an example with clojure code that will be syntax highlighted:\r\n\r\n```html\r\n
    \r\n\t
    \r\n(def lazy-fib\r\n  (concat\r\n   [0 1]\r\n   ((fn rfib [a b]\r\n        (lazy-cons (+ a b) (rfib b (+ a b)))) 0 1)))\r\n\t
    \r\n
    \r\n```\r\n\r\n\r\n### Overview mode\r\n\r\nPress \"Esc\" key to toggle the overview mode on and off. While you're in this mode, you can still navigate between slides,\r\nas if you were at 1,000 feet above your presentation. The overview mode comes with a few API hooks:\r\n\r\n```javascript\r\nReveal.addEventListener( 'overviewshown', function( event ) { /* ... */ } );\r\nReveal.addEventListener( 'overviewhidden', function( event ) { /* ... */ } );\r\n\r\n// Toggle the overview mode programmatically\r\nReveal.toggleOverview();\r\n```\r\n\r\n### Fullscreen mode\r\nJust press »F« on your keyboard to show your presentation in fullscreen mode. Press the »ESC« key to exit fullscreen mode.\r\n\r\n\r\n## PDF Export\r\n\r\nPresentations can be exported to PDF via a special print stylesheet. This feature requires that you use [Google Chrome](http://google.com/chrome). \r\nHere's an example of an exported presentation that's been uploaded to SlideShare: http://www.slideshare.net/hakimel/revealjs-13872948.\r\n\r\n1. 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).\r\n2. Open the in-browser print dialog (CMD+P).\r\n3. Change the **Destination** setting to **Save as PDF**.\r\n4. Change the **Layout** to **Landscape**.\r\n5. Change the **Margins** to **None**.\r\n6. Click **Save**.\r\n\r\n![Chrome Print Settings](https://s3.amazonaws.com/hakim-static/reveal-js/pdf-print-settings.png)\r\n\r\n\r\n## Speaker Notes\r\n\r\nreveal.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 the presentation URL or press the 's' key on your keyboard to open the notes window.\r\n\r\nBy default notes are written using standard HTML, see below, but you can add a ```data-markdown``` attribute to the ```