300 lines
12 KiB
Markdown
300 lines
12 KiB
Markdown
# reveal.js
|
|
|
|
A framework for easily creating beautiful presentations using HTML. [Check out the live demo](http://lab.hakim.se/reveal-js/).
|
|
|
|
reveal.js comes with a broad range of features including [nested slides](https://github.com/hakimel/reveal.js#markup), [markdown contents](https://github.com/hakimel/reveal.js#markdown), [PDF export](https://github.com/hakimel/reveal.js#pdf-export), [speaker notes](https://github.com/hakimel/reveal.js#speaker-notes) and a [JavaScript API](https://github.com/hakimel/reveal.js#api). It's best viewed in a browser with support for CSS 3D transforms but [fallbacks](https://github.com/hakimel/reveal.js/wiki/Browser-Support) are available to make sure your presentation can still be viewed elsewhere.
|
|
|
|
|
|
#### More reading in the Wiki:
|
|
- [Changelog](https://github.com/hakimel/reveal.js/wiki/Changelog): Up-to-date version history.
|
|
- [Examples](https://github.com/hakimel/reveal.js/wiki/Example-Presentations): Presentations created with reveal.js, add your own!
|
|
- [Browser Support](https://github.com/hakimel/reveal.js/wiki/Browser-Support): Explanation of browser support and fallbacks.
|
|
|
|
## rvl.io
|
|
|
|
Slides are written using HTML or markdown but there's also an online editor for those of you who prefer a more traditional user interface. Give it a try at [www.rvl.io](http://www.rvl.io).
|
|
|
|
|
|
## Instructions
|
|
|
|
### 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:
|
|
|
|
```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](https://gist.github.com/1343518) from [Paul Irish](https://github.com/paulirish) which in turn uses [showdown](https://github.com/coreyti/showdown/). This is sensitive to indentation (avoid mixing tabs and spaces) and line breaks (avoid consecutive breaks).
|
|
|
|
```html
|
|
<section data-markdown>
|
|
<script type="text/template">
|
|
## Page title
|
|
|
|
A paragraph with some text and a [link](http://hakim.se).
|
|
</script>
|
|
</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 the slide overview mode
|
|
overview: true,
|
|
|
|
// Vertical centering of slides
|
|
center: true,
|
|
|
|
// Loop the presentation
|
|
loop: 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: true,
|
|
|
|
// Apply a 3D roll to links on hover
|
|
rollingLinks: true,
|
|
|
|
// Transition style
|
|
transition: 'default' // default/cube/page/concave/zoom/linear/none
|
|
});
|
|
```
|
|
|
|
### 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 - https://github.com/eligrey/classList.js/
|
|
{ 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/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; } }
|
|
]
|
|
});
|
|
```
|
|
|
|
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
|
|
|
|
|
|
### API
|
|
|
|
The Reveal class provides a minimal JavaScript API for controlling navigation and reading state:
|
|
|
|
```javascript
|
|
// Navigation
|
|
Reveal.slide( indexh, indexv );
|
|
Reveal.left();
|
|
Reveal.right();
|
|
Reveal.up();
|
|
Reveal.down();
|
|
Reveal.prev();
|
|
Reveal.next();
|
|
Reveal.prevFragment();
|
|
Reveal.nextFragment();
|
|
Reveal.toggleOverview();
|
|
|
|
// 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:
|
|
|
|
```javascript
|
|
Reveal.addEventListener( 'somestate', function() {
|
|
// TODO: Sprinkle magic
|
|
}, false );
|
|
```
|
|
|
|
### 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 change 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.
|
|
|
|
```javascript
|
|
Reveal.addEventListener( 'slidechanged', function( event ) {
|
|
// event.previousSlide, event.currentSlide, event.indexh, event.indexv
|
|
} );
|
|
```
|
|
|
|
### 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 slide or horizontal slide -->
|
|
<a href="#" class="navigate-next"> <!-- Next vertical or horizontal slide -->
|
|
```
|
|
|
|
|
|
### Fullscreen mode
|
|
Just press »F« on your keyboard to show your presentation in fullscreen mode. Press the »ESC« key to exit fullscreen mode.
|
|
|
|
### 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
|
|
|
|
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>
|
|
```
|
|
|
|
### 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.
|
|
|
|
### Fragment events
|
|
|
|
When a slide fragment is either shown or hidden reveal.js will dispatch an event.
|
|
|
|
```javascript
|
|
Reveal.addEventListener( 'fragmentshown', function( event ) {
|
|
// event.fragment = the fragment DOM element
|
|
} );
|
|
Reveal.addEventListener( 'fragmenthidden', function( event ) {
|
|
// event.fragment = the fragment DOM element
|
|
} );
|
|
```
|
|
|
|
|
|
## PDF Export
|
|
|
|
Presentations can be exported to PDF via a special print stylesheet. This feature requires that you use [Google Chrome](http://google.com/chrome).
|
|
Here's an example of an exported presentation that's been uploaded to SlideShare: http://www.slideshare.net/hakimel/revealjs-13872948.
|
|
|
|
1. Open your presentation with [css/print/pdf.css](https://github.com/hakimel/reveal.js/blob/master/css/print/pdf.css) included on the page. The default index HTML lets you add *print-pdf* anywhere in the query to include the stylesheet, for example: [lab.hakim.se/reveal-js?print-pdf](http://lab.hakim.se/reveal-js?print-pdf).
|
|
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**.
|
|
|
|
|
|
|
|
|
|
## 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 presentation URL or 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.
|
|
|
|
```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>
|
|
```
|
|
|
|
## Server Side Speaker Nodes
|
|
|
|
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 requried scripts by adding the following dependencies:
|
|
|
|
```
|
|
{ src: '/socket.io/socket.io.js', async: true },
|
|
{ src: 'plugin/notes-server/client.js', async: true }
|
|
```
|
|
|
|
Then:
|
|
|
|
1. Install [Node.js](http://nodejs.org/)
|
|
2. Run ```npm install```
|
|
3. Run ```node plugin/notes-server```
|
|
|
|
|
|
## 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)
|
|
|
|
## License
|
|
|
|
MIT licensed
|
|
|
|
Copyright (C) 2011-2012 Hakim El Hattab, http://hakim.se
|
|
|