name mode size
css 040000
imgs 040000
js 040000
lib 040000
plugin 040000
resources 040000
test 040000
Gruntfile.js 100755 3 kb
LICENSE 100755 1 kb 100755 32 kb
ca.gv 100644 2 kb
index.html 100644 21 kb
package.json 100755 1 kb
# 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: - [Installation](#installation): Step-by-step instructions for getting reveal.js running on your computer. - [Changelog]( Up-to-date version history. - [Examples]( Presentations created with reveal.js, add your own! - [Browser Support]( Explanation of browser support and fallbacks. ## Slides 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 []( ## Instructions ### 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: ```html <div class="reveal"> <div class="slides"> <section>Single Horizontal Slide</section> <section> <section>Vertical Slide 1</section> <section>Vertical Slide 2</section> </section> </div> </div> ``` ### 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]( modified to use [marked]( to support [Github Flavoured Markdown]( Sensitive to indentation (avoid mixing tabs and spaces) and line breaks (avoid consecutive breaks). ```html <section data-markdown> <script type="text/template"> ## Page title A paragraph with some text and a [link]( </script> </section> ``` #### 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. The ```data-charset``` attribute is optional and specifies which charset to use when loading the external file. ```html <section data-markdown="" data-separator="^\n\n\n" data-vertical="^\n\n" data-notes="^Note:" data-charset="iso-8859-15"></section> ``` ### 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. ```javascript Reveal.initialize({ // Display controls in the bottom right corner controls: true, // Display a presentation progress bar progress: true, // Push each slide change to the browser history history: false, // Enable keyboard shortcuts for navigation keyboard: true, // Enable touch events for navigation touch: true, // Enable the slide overview mode overview: true, // Vertical centering of slides center: true, // Loop the presentation loop: false, // Change the presentation direction to be RTL rtl: false, // 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, // Enable slide navigation via mouse wheel mouseWheel: false, // Transition style 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/none }); ``` Note 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`. The configuration can be updated after initialization using the ```configure``` method: ```javascript // Turn autoSlide off Reveal.configure({ autoSlide: 0 }); // Start auto-sliding every 5s Reveal.configure({ autoSlide: 5000 }); ``` ### 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: ```javascript Reveal.initialize({ dependencies: [ // Cross-browser shim that fully implements classList - { src: 'lib/js/classList.js', condition: function() { return !document.body.classList; } }, // Interpret Markdown in <section> elements { 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 { src: 'plugin/highlight/highlight.js', async: true, callback: function() { hljs.initHighlightingOnLoad(); } }, // Zoom in and out with Alt+click { src: 'plugin/zoom-js/zoom.js', async: true, condition: function() { return !!document.body.classList; } }, // Speaker notes { src: 'plugin/notes/notes.js', async: true, condition: function() { return !!document.body.classList; } }, // Remote control your reveal.js presentation using a touch device { src: 'plugin/remotes/remotes.js', async: true, condition: function() { return !!document.body.classList; } }, // MathJax { src: 'plugin/math/math.js', async: true } ] }); ``` You can add your own extensions using the same syntax. The following properties are available for each dependency object: - **src**: Path to the script to load - **async**: [optional] Flags if the script should load after reveal.js has started, defaults to false - **callback**: [optional] Function to execute when the script has loaded - **condition**: [optional] Function which must return true for the script to be loaded ### 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: ```javascript 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 }); ``` ### Keyboard Bindings If you're unhappy with any of the default keyboard bindings you can override them using the ```keyboard``` config option: ```javascript 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: ```javascript // Navigation Reveal.slide( indexh, indexv, indexf ); Reveal.left(); Reveal.right(); Reveal.up(); Reveal.down(); Reveal.prev();; 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 } } // State checks Reveal.isFirstSlide(); Reveal.isLastSlide(); Reveal.isOverview(); Reveal.isPaused(); ``` ### Ready Event The 'ready' event is fired when reveal.js has loaded all (synchronous) dependencies and is ready to start navigating. ```javascript Reveal.addEventListener( 'ready', function( event ) { // event.currentSlide, event.indexh, event.indexv } ); ``` ### 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. Some libraries, like MathJax (see [#226](, 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. ```javascript Reveal.addEventListener( 'slidechanged', function( event ) { // event.previousSlide, event.currentSlide, event.indexh, event.indexv } ); ``` ### 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: ```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. ```html <section data-background="#ff0000"> <h2>All CSS color formats are supported, like rgba() or hsl().</h2> </section> <section data-background=""> <h2>This slide will have a full-size background image.</h2> </section> <section data-background="" 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: ```html <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">```): ```html <a href="#/2/2">Link</a> <a href="#/some-slide">Link</a> ``` You 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. ```html <a href="#" class="navigate-left"> <a href="#" class="navigate-right"> <a href="#" class="navigate-up"> <a href="#" class="navigate-down"> <a href="#" class="navigate-prev"> <!-- Previous vertical or horizontal slide --> <a href="#" class="navigate-next"> <!-- Next vertical or horizontal slide --> ``` ### Fragments 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: 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: ```html <section> <p class="fragment grow">grow</p> <p class="fragment shrink">shrink</p> <p class="fragment roll-in">roll-in</p> <p class="fragment fade-out">fade-out</p> <p class="fragment highlight-red">highlight-red</p> <p class="fragment highlight-green">highlight-green</p> <p class="fragment highlight-blue">highlight-blue</p> </section> ``` Multiple 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. ```html <section> <span class="fragment fade-in"> <span class="fragment fade-out">I'll fade in, then out</span> </span> </section> ``` The display order of fragments can be controlled using the ```data-fragment-index``` attribute. ```html <section> <p class="fragment" data-fragment-index="3">Appears last</p> <p class="fragment" data-fragment-index="1">Appears first</p> <p class="fragment" data-fragment-index="2">Appears second</p> </section> ``` ### Fragment events When a slide fragment is either shown or hidden reveal.js will dispatch an event. Some libraries, like MathJax (see #505), get confused by the initially hidden fragment elements. Often times this can be fixed by calling their update or render function from this callback. ```javascript Reveal.addEventListener( 'fragmentshown', function( event ) { // event.fragment = the fragment DOM element } ); Reveal.addEventListener( 'fragmenthidden', function( event ) { // event.fragment = the fragment DOM element } ); ``` ### 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. When the `data-trim` attribute is present surrounding whitespace is automatically removed. ```html <section> <pre><code data-trim> (def lazy-fib (concat [0 1] ((fn rfib [a b] (lazy-cons (+ a b) (rfib b (+ a b)))) 0 1))) </code></pre> </section> ``` ### Overview mode Press "Esc" or "o" keys 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: ```javascript Reveal.addEventListener( 'overviewshown', function( event ) { /* ... */ } ); Reveal.addEventListener( 'overviewhidden', function( event ) { /* ... */ } ); // Toggle the overview mode programmatically Reveal.toggleOverview(); ``` ### Fullscreen mode Just press »F« on your keyboard to show your presentation in fullscreen mode. Press the »ESC« key to exit fullscreen mode. ### Embedded media Embedded HTML5 `<video>`/`<audio>` and YouTube iframes are automatically paused when you 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: ```html <video data-autoplay src=""></video> ``` ### Stretching elements Sometimes it's desirable to have an element, like an image or video, stretch to consume as much space as possible within a given slide. This can be done by adding the ```.stretch``` class to an element as seen below: ```html <section> <h2>This video will use up the remaining space on the slide</h2> <video class="stretch" src=""></video> </section> ``` Limitations: - Only direct descendants of a slide section can be stretched - Only one descendant per slide section can be stretched ## PDF Export 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: 1. Open your presentation with [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: []( 2. Open the in-browser print dialog (CMD+P). 3. Change the **Destination** setting to **Save as PDF**. 4. Change the **Layout** to **Landscape**. 5. Change the **Margins** to **None**. 6. Click **Save**. ![Chrome Print Settings]( ## Theming The framework comes with a few different themes included: - 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: ```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/]( ## 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. Press the 's' key on your keyboard to open the notes window. Notes are defined by appending an ```<aside>``` element to a slide as seen below. You can add the ```data-markdown``` attribute to the aside element if you prefer writing notes using Markdown. ```html <section> <h2>Some Slide</h2> <aside class="notes"> 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). </aside> </section> ``` If you're using the external Markdown plugin, you can add notes with the help of a special delimiter: ```html <section data-markdown="" data-separator="^\n\n\n" data-vertical="^\n\n" data-notes="^Note:"></section> # Title ## Sub-title Here is some content... Note: This will only display in the notes window. ``` ## 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: ```javascript Reveal.initialize({ ... dependencies: [ { src: '', async: true }, { src: 'plugin/notes-server/client.js', async: true } ] }); ``` Then: 1. Install [Node.js]( 2. Run ```npm install``` 3. Run ```node plugin/notes-server``` ## 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 []( The multiplex plugin needs the following 3 things to operate: 1. Master presentation that has control 2. Client presentations that follow the master 3. server to broadcast events from the master to the clients More details: #### Master presentation 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: 1. ```npm install node-static``` 2. ```static``` 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 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: ```javascript Reveal.initialize({ // other options... multiplex: { // Example values. To generate your own, see the server instructions. secret: '13652805320794272084', // Obtained from the server. Gives this (the master) control of the presentation id: '1ea875674b17ca76', // Obtained from server url: '' // Location of server }, // Don't forget to add the dependencies dependencies: [ { src: '//', async: true }, { src: 'plugin/multiplex/master.js', async: true }, // and if you want speaker notes { src: 'plugin/notes-server/client.js', async: true } // other dependencies... ] }); ``` #### Client presentation 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 ``````, with the configuration below causing them to connect to the server as clients. Example configuration: ```javascript Reveal.initialize({ // other options... multiplex: { // Example values. To generate your own, see the server instructions. secret: null, // null so the clients do not have control of the master presentation id: '1ea875674b17ca76', // id, obtained from server url: '' // Location of server }, // Don't forget to add the dependencies dependencies: [ { src: '//', async: true }, { src: 'plugin/multiplex/client.js', async: true } // other dependencies... ] }); ``` #### server 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 server with the commands: 1. ```npm install``` 2. ```node plugin/multiplex``` Or you use the server at []( You'll need to generate a unique secret and token pair for your master and client presentations. To do so, visit ``````, where `````` is the location of your server. Or if you're going to use the server at [](, visit []( You are very welcome to point your presentations at the server running at [](, 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. ##### server as file static server The server can play the role of static file server for your client presentation, as in the example at []( (Open []( in two browsers. Navigate through the slides on one, and the other will update to match.) Example configuration: ```javascript Reveal.initialize({ // other options... multiplex: { // Example values. To generate your own, see the server instructions. secret: null, // null so the clients do not have control of the master presentation id: '1ea875674b17ca76', // id, obtained from server url: '' // Location of your server }, // Don't forget to add the dependencies dependencies: [ { src: '//', async: true }, { src: 'plugin/multiplex/client.js', async: true } // other dependencies... ] ``` 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 []( 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: ```javascript Reveal.initialize({ // other options... multiplex: { // Example values. To generate your own, see the server instructions. secret: '13652805320794272084', // Obtained from the server. Gives this (the master) control of the presentation id: '1ea875674b17ca76', // Obtained from server url: '' // Location of your server }, // Don't forget to add the dependencies dependencies: [ { src: '//', async: true }, { src: 'plugin/multiplex/master.js', async: true }, { src: 'plugin/multiplex/client.js', async: true } // other dependencies... ] }); ``` ## Leap Motion The Leap Motion plugin lets you utilize your [Leap Motion]( device to control basic navigation of your presentation. The gestures currently supported are: ##### 1 to 2 fingers Pointer &mdash; Point to anything on screen. Move your finger past the device to expand the pointer. ##### 1 hand + 3 or more fingers (left/right/up/down) Navigate through your slides. See config options to invert movements. ##### 2 hands upwards Toggle the overview mode. Do it a second time to exit the overview. #### Config Options You can edit the following options: | Property | Default | Description | ----------------- |:-----------------:| :------------- | autoCenter | true | Center the pointer based on where you put your finger into the leap motions detection field. | gestureDelay | 500 | How long to delay between gestures in milliseconds. | naturalSwipe | true | Swipe as though you were touching a touch screen. Set to false to invert. | pointerColor | #00aaff | The color of the pointer. | pointerOpacity | 0.7 | The opacity of the pointer. | pointerSize | 15 | The minimum height and width of the pointer. | pointerTolerance | 120 | Bigger = slower pointer. Example configuration: ```js Reveal.initialize({ // other options... leap: { naturalSwipe : false, // Invert swipe gestures pointerOpacity : 0.5, // Set pointer opacity to 0.5 pointerColor : '#d80000' // Red pointer }, dependencies: [ { src: 'plugin/leap/leap.js', async: true } ] }); ``` ## MathJax If you want to display math equations in your presentation you can easily do so by including this plugin. The plugin is a very thin wrapper around the [MathJax]( library. To use it you'll need to include it as a reveal.js dependency, [find our more about dependencies here](#dependencies). The plugin defaults to using [LaTeX]( but that can be adjusted through the ```math``` configuration object. Note that MathJax is loaded from a remote server. If you want to use it offline you'll need to download a copy of the library and adjust the ```mathjax``` configuration value. Below is an example of how the plugin can be configured. If you don't intend to change these values you do not need to include the ```math``` config object at all. ```js Reveal.initialize({ // other options ... math: { mathjax: '', config: 'TeX-AMS_HTML-full' // See }, dependencies: [ { src: 'plugin/math/math.js', async: true } ] }); ``` Read MathJax's documentation if you need [HTTPS delivery]( or serving of [specific versions]( for stability. ## Installation The **basic setup** is for authoring presentations only. The **full setup** gives you access to all reveal.js features and plugins such as speaker notes 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 <> 2. Unzip and replace the example contents in index.html with your own 3. Open index.html in a browser to view it ### 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. Install [Grunt]( 4. Clone the reveal.js repository ``` $ git clone ``` 5. Navigate to the reveal.js folder ``` $ cd reveal.js ``` 6. Install dependencies ``` $ npm install ``` 7. Serve the presentation and monitor source files for changes ``` $ grunt serve ``` 8. Open <http://localhost:8000> to view your presentation You can change the port by using `grunt serve --port 8001`. ### Folder Structure - **css/** Core styles without which the project does not function - **js/** Like above but for JavaScript - **plugin/** Components that have been developed as extensions to reveal.js - **lib/** All other third party assets (JavaScript, CSS, fonts) ### Contributing Please keep the [issue tracker]( limited to **bug reports**, **feature requests** and **pull requests**. If you are reporting a bug make sure to include information about which browser and operating system you are using as well as the necessary steps to reproduce the issue. If you have personal support questions use [StackOverflow]( #### Pull requests - Should follow the coding style - Tabs to indent - Single-quoted strings - No space between function name and opening argument parenthesis - One space after opening and before closing parenthesis - Should be made towards the **dev branch** - Should be submitted from a feature/topic branch (not your master) ## License MIT licensed Copyright (C) 2013 Hakim El Hattab,