Go to file

Hakim El Hattab 6e91411054 Merge branch 'master' of github.com:hakimel/reveal.js		2012-08-04 11:06:13 -04:00
css	Merge pull request #93 from StereotypicalApps/patch-1	2012-08-04 08:05:52 -07:00
js	correct copy year	2012-08-03 23:15:34 -04:00
lib	ie8 support (closes #96 )	2012-08-03 21:50:06 -04:00
plugin/speakernotes	slidenotes becomes speakernotes to match wording in readme	2012-07-09 21:30:54 -04:00
.gitignore	taking a stab at a presenter notes server	2012-06-07 23:21:14 -04:00
index.html	Include speaker notes plugin after reveal.js	2012-08-04 14:33:27 +10:00
LICENSE	correct copy year	2012-08-03 23:15:34 -04:00
package.json	include underscore as a dependency for npm	2012-07-01 16:39:08 -04:00
README.md	disable 3d links in ie, reorder script loading in index for readability (closes #95 )	2012-08-03 22:41:31 -04:00

README.md

reveal.js

A CSS 3D slideshow tool for quickly creating good looking HTML presentations. Doesn't rely on any external libraries but highlight.js is included by default for code highlighting.

Note that this requires a browser with support for CSS 3D transforms and classList. If CSS 3D support is not detected, the presentation will degrade to less exciting 2D transitions. A classList polyfill is incuded to make this work in < iOS 5, < Safari 5.1 and IE.

Curious about how it looks in action? Check out the demo page.

Usage

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:

<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 from Paul Irish which in turn uses showdown. This is sensitive to indentation (avoid mixing tabs and spaces) and line breaks (avoid consecutive breaks). Updates to come.

<section data-markdown>
	## Page title
	
	A paragraph with some text and a [link](http://hakim.se).
</section>

Configuration

At the end of your page, after <script src="js/reveal.js"></script>, you need to initialize reveal by running the following code. Note that all config values are optional and will default as specified below.

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,

	// UI style
	theme: 'default', // default/neon/beige

	// 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:

// 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:

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.

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.

Reveal.addEventListener( 'fragmentshown', function( event ) {
	// event.fragment = the fragment DOM element
} );
Reveal.addEventListener( 'fragmenthidden', function( event ) {
	// event.fragment = the fragment DOM element
} );

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)

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; 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.

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.

Examples

Send me a link if you used reveal.js for a project or presentation.

History

1.5 (master/beta)

New API method Reveal.getPreviousSlide()
New API method Reveal.getCurrentSlide()
New API method Reveal.getIndices()
Fixed bug where the .present class was sometimes left on the previous slide
Added support for slides written using markdown
Added helped method Reveal.getQueryHash()
Added EOT font for IE support
IE8 support
Fixed bug where hovering 3D links in Chrome caused them to disappear
Disable 3D links in IE and more accurate CSS feature detection

1.4

Main #reveal container is now selected via a class instead of ID
API methods for adding or removing all event listeners
The slidechange event now includes currentSlide and previousSlide
Fixed bug where slidechange was firing twice when history was enabled
Folder structure updates for scalability (see /lib & /plugin)
Slide notes by rmurphey
Bumped up default font-size for code samples
Added beige theme
Added autoSlide config
Bug fix: The slidechanged event is now firing upon hashchange. Thanks basecode
Bug fix: JS error when the progress option was true but there was no progress DOM element
keyboard config flag for disabling all keyboard navigation

1.3

Revised keyboard shortcuts, including ESC for overview, N for next, P for previous. Thanks mahemoff
Added support for looped presentations via config
Fixed IE9 fallback
Added event binding methods (Reveal.addEventListener, Reveal.removeEventListener)
Added slidechanged event
Added print styles. Thanks skypanther
The address bar now hides automatically on mobile browsers
Space and return keys can be used to exit the overview mode
Events for fragment states (fragmentshown / fragmenthidden)
Support for swipe navigation on touch devices. Thanks akiersky
Support for pinch to overview on touch devices

1.2

Big changes to DOM structure:
- Previous #main wrapper is now called #reveal
- Slides were moved one level deeper, into #reveal .slides
- Controls and progress bar were moved into #reveal
CSS is now much more explicit, rooted at #reveal, to prevent conflicts
Config option for disabling updates to URL, defaults to true
Anchors with image children no longer rotate in 3D on hover
Support for mouse wheel navigation (naugtur)
Delayed updates to URL hash to work around a bug in Chrome
Included a classList polyfill for IE9
Support for wireless presenter keys
States can now be applied as classes on the document element by adding data-state on a slide

1.1

Added an optional presentation progress bar
Images wrapped in anchors no longer unexpectedly flip in 3D
Slides that contain other slides are given the 'stack' class
Added transition option for specifying transition styles
Added theme option for specifying UI styles
New transitions: box & page
New theme: neon

1.0

New and improved style
Added controls in bottom right which indicate where you can navigate
Reveal views in iteratively by giving them the .fragment class
Code sample syntax highlighting thanks to highlight.js
Initialization options (toggling controls, toggling rolling links, transition theme)

0.3

Added licensing terms
Fixed broken links on touch devices

0.2

Refactored code and added inline documentation
Slides now have unique URL's
A basic API to invoke navigation was added

0.1

First release
Transitions and a white theme

License

MIT licensed