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.
-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.
-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>
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>
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>
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 }); -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
-
-});
-
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 loadedAll 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
+
+});
+
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)
+ }
+});
+
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 } }
-
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();
The 'ready' event is fired when reveal.js has loaded all (synchronous) dependencies and is ready to start navigating.
@@ -253,7 +286,8 @@ } ); -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 @@ } ); -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 );
+
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.
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.
+ +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">
):
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> -When a slide fragment is either shown or hidden reveal.js will dispatch an event.
@@ -329,12 +412,13 @@ } ); -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>
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(); -Just press »F« on your keyboard to show your presentation in fullscreen mode. Press the »ESC« key to exit fullscreen mode.
-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>
+
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.
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.
+ +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.
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 SlideSharenode plugin/notes-server
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:
+ +More details:
+ +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:
npm install node-static
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 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.
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.
Example configuration:
-The framework comes with a few different themes included:
+Reveal.initialize({
+ // other options
-
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.
+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.
npm install
node plugin/multiplex
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.
+ +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 }
+ ]
+});
+
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.
+ +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.
+ +Download the latest version of reveal.js from https://github.com/hakimel/reveal.js/releases
Unzip and replace the example contents in index.html with your own
Open index.html in a browser to view it
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.
+ +Install Node.js
Install Grunt
Clone the reveal.js repository
+ +$ git clone git@github.com:hakimel/reveal.js.git
+
+Navigate to the reveal.js folder
+ +$ cd reveal.js
+
+Install dependencies
+ +$ npm install
+
+Serve the presentation and monitor source files for changes
+ +$ grunt serve
+
+Open http://localhost:8000 to view your presentation
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 ``