184 lines
6.8 KiB
Markdown
184 lines
6.8 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/Changelog): Explanation of browser support and fallbacks.
|
|
|
|
|
|
## 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. 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 simply add the ```data-markdown``` attribute to your ```<section>``` elements and reveal.js will automatically load the JavaScript parser.
|
|
|
|
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). Updates to come.
|
|
|
|
```html
|
|
<section data-markdown>
|
|
## Page title
|
|
|
|
A paragraph with some text and a [link](http://hakim.se).
|
|
</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,
|
|
|
|
// Loop the presentation
|
|
loop: false,
|
|
|
|
// Number of milliseconds between automatically proceeding to the
|
|
// next slide, disabled when set to 0
|
|
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/linear(2d)
|
|
});
|
|
```
|
|
|
|
### API
|
|
|
|
The Reveal class provides a minimal JavaScript API for controlling navigation and reading state:
|
|
|
|
```javascript
|
|
// Navigation
|
|
Reveal.navigateTo( indexh, indexv );
|
|
Reveal.navigateLeft();
|
|
Reveal.navigateRight();
|
|
Reveal.navigateUp();
|
|
Reveal.navigateDown();
|
|
Reveal.navigatePrev();
|
|
Reveal.navigateNext();
|
|
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 );
|
|
```
|
|
|
|
### 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
|
|
} );
|
|
```
|
|
|
|
### 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 the desired presentation with *print-pdf* anywhere in the query, 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
|
|
|
|
If you're interested in using speaker notes, reveal.js comes with a Node server that allows you to deliver your presentation in one browser while viewing speaker notes in another.
|
|
|
|
To include speaker notes in your presentation, simply add an `<aside class="notes">` element to any slide. These notes will be hidden in the main presentation view.
|
|
|
|
You'll also need to [install Node.js](http://nodejs.org/); then, install the server dependencies by running `npm install`.
|
|
|
|
Once Node.js and the dependencies are installed, run the following command from the root directory:
|
|
|
|
node plugin/speakernotes
|
|
|
|
By default, the slides will be served at [localhost:1947](http://localhost:1947).
|
|
|
|
You can change the appearance of the speaker notes by editing the file at `plugin/speakernotes/notes.html`.
|
|
|
|
### Known Issues
|
|
|
|
- The notes page is supposed to show the current slide and the next slide, but when it first starts, it always shows the first slide in both positions.
|
|
|
|
## 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 |