📄 README.md

reveal.js

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 modern browser but fallbacks are available to make sure your presentation can still be viewed elsewhere.

Online Editor

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://slides.com.

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: %%CODEBLOCK0%% ### 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) modified to use [marked](https://github.com/chjj/marked) to support [Github Flavoured Markdown](https://help.github.com/articles/github-flavored-markdown). Sensitive to indentation (avoid mixing tabs and spaces) and line breaks (avoid consecutive breaks). %%CODEBLOCK1%% #### 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. When used locally, this feature requires that reveal.js [runs from a local web server](#full-setup). %%CODEBLOCK2%% #### Element Attributes Special syntax (in html comment) is available for adding attributes to Markdown elements. This is useful for fragments, amongst other things. %%CODEBLOCK3%% #### Slide Attributes Special syntax (in html comment) is available for adding attributes to the slide

 elements generated by your Markdown.

%%CODEBLOCK4%%


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

%%CODEBLOCK5%%


The configuration can be updated after initialization using the

`configure`

 method:

%%CODEBLOCK6%%


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

%%CODEBLOCK7%%


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

%%CODEBLOCK8%%

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


### Ready Event

A 'ready' event is fired when reveal.js has loaded all non-async dependencies and is ready to start navigating. To check if reveal.js is already 'ready' you can call

Reveal.isReady()

.

%%CODEBLOCK9%%


### Auto-sliding

Presentations can be configured to progress through slides automatically, without any user input. To enable this you will need to tell the framework how many milliseconds it should wait between slides:

%%CODEBLOCK10%%
When this is turned on a control element will appear that enables users to pause and resume auto-sliding. Alternatively, sliding can be paused or resumed by pressing »a« on the keyboard. Sliding is paused automatically as soon as the user starts navigating. You can disable these controls by specifying

`autoSlideStoppable: false`

 in your reveal.js config.

You can also override the slide duration for individual slides and fragments by using the

`data-autoslide`

 attribute:

%%CODEBLOCK11%%

Whenever the auto-slide mode is resumed or paused the

`autoslideresumed` and `autoslidepaused`

 events are fired.


### Keyboard Bindings

If you're unhappy with any of the default keyboard bindings you can override them using the

`keyboard`

 config option:

%%CODEBLOCK12%%

### Touch Navigation

You can swipe to navigate through a presentation on any touch-enabled device. Horizontal swipes change between horizontal slides, vertical swipes change between vertical slides. If you wish to disable this you can set the

touch

 config option to false when initializing reveal.js.

If there's some part of your content that needs to remain accessible to touch events you'll need to highlight this by adding a

data-prevent-swipe

 attribute to the element. One common example where this is useful is elements that need to be scrolled.


### Lazy Loading

When working on presentation with a lot of media or iframe content it's important to load lazily. Lazy loading means that reveal.js will only load content for the few slides nearest to the current slide. The number of slides that are preloaded is determined by the

viewDistance

 configuration option.

To enable lazy loading all you need to do is change your "src" attributes to "data-src" as shown below. This is supported for image, video, audio and iframe elements. Lazy loaded iframes will also unload when the containing slide is no longer visible.

%%CODEBLOCK13%%


### API

The

Reveal

 object exposes a JavaScript API for controlling navigation and reading state:

%%CODEBLOCK14%%

### Slide Changed Event

A '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](https://github.com/hakimel/reveal.js/issues/226#issuecomment-10261609)), 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.

%%CODEBLOCK15%%

### Presentation State

The presentation's current state can be fetched by using the

getState method. A state object contains all of the information required to put the presentation back as it was when getState

 was first called. Sort of like a snapshot. It's a simple object that can easily be stringified and persisted or sent over the wire.

%%CODEBLOCK16%%

### Slide 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:

%%CODEBLOCK17%%

### 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 backgrounds outside of the slide area by adding a

`data-background` attribute to your `<section>`

 elements. Four different types of backgrounds are supported: color, image, video and iframe. Below are a few examples.

%%CODEBLOCK18%%

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.


### Parallax Background

If you want to use a parallax scrolling background, set the first two config properties below when initializing reveal.js (the other two are optional).

%%CODEBLOCK19%%

Make sure that the background size is much bigger than screen size to allow for some scrolling. [View example](http://lab.hakim.se/reveal-js/?parallaxBackgroundImage=https%3A%2F%2Fs3.amazonaws.com%2Fhakim-static%2Freveal-js%2Freveal-parallax-1.jpg&parallaxBackgroundSize=2100px%20900px).



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

%%CODEBLOCK20%%

You can also use different in and out transitions for the same slide:

%%CODEBLOCK21%%


### 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">`

):

%%CODEBLOCK22%%

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.

%%CODEBLOCK23%%


### 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: http://lab.hakim.se/reveal-js/#/fragments

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:

%%CODEBLOCK24%%

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.

%%CODEBLOCK25%%

The display order of fragments can be controlled using the

`data-fragment-index`

 attribute.

%%CODEBLOCK26%%

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

%%CODEBLOCK27%%

### Code syntax highlighting

By default, Reveal is configured with [highlight.js](https://highlightjs.org/) 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 will be escaped by default. To avoid this, for example if you are using

to call out a line of code, add the data-noescape attribute to the

 element.

%%CODEBLOCK28%%

### Slide number
If you would like to display the page number of the current slide you can do so using the `slideNumber` configuration value.

%%CODEBLOCK29%%


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

%%CODEBLOCK30%%

### 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

📦 ibakaidov / miniwas

reveal.js

More reading:

Online Editor

Instructions

Markup

Folder Structure

License