-A framework for easily creating beautiful presentations using HTML. [Check out the live demo](https://revealjs.com/).
+reveal.js is an open source HTML presentation framework. It's a tool that enables anyone with a web browser to create fully featured and beautiful presentations for free. [Check out the live demo](https://revealjs.com/).
-reveal.js comes with a broad range of features including [nested slides](https://github.com/hakimel/reveal.js#markup), [Markdown support](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). There's also a fully featured visual editor and platform for sharing reveal.js presentations at [slides.com](https://slides.com?ref=github).
+----
-### Supporting reveal.js
-This project was started and is maintained by [@hakimel](https://github.com/hakimel/) with the help of many [contributions from the community](https://github.com/hakimel/reveal.js/graphs/contributors). The best way to support the project is to [become a paying member of Slides.com](https://slides.com/pricing)—the reveal.js presentation platform that Hakim is building.
-
-
-## Table of contents
-
-- [Online Editor](#online-editor)
-- [Installation](#installation)
- - [Basic setup](#basic-setup)
- - [Full setup](#full-setup)
-- [Markup](#markup)
-- [Initialization](#initialization)
-- [Configuration](#configuration)
-- [Presentation Size](#presentation-size)
-- [Ready Event](#ready-event)
-- [Auto-Slide](#auto-slide)
-- [Auto-Animate](#auto-animate)
-- [Keyboard Bindings](#keyboard-bindings)
-- [Vertical Slide Navigation](#vertical-slide-navigation)
-- [Touch Navigation](#touch-navigation)
-- [Lazy Loading](#lazy-loading)
-- [Plugins](#plugins)
-- [Dependencies](#dependencies)
-- [API](#api)
- - [Custom Key Bindings](#custom-key-bindings)
- - [Slide Change Events](#slide-change-events)
- - [Presentation State](#presentation-state)
- - [Slide States](#slide-states)
- - [Slide Backgrounds](#slide-backgrounds)
- - [Parallax Background](#parallax-background)
- - [Slide Transitions](#slide-transitions)
- - [Internal links](#internal-links)
- - [Fragments](#fragments)
- - [Fragment events](#fragment-events)
- - [Code syntax highlighting](#code-syntax-highlighting)
- - [Slide number](#slide-number)
- - [Overview mode](#overview-mode)
- - [Fullscreen mode](#fullscreen-mode)
- - [Embedded media](#embedded-media)
- - [Stretching elements](#stretching-elements)
- - [Resize Event](#resize-event)
- - [postMessage API](#postmessage-api)
-- [Markdown](#markdown)
- - [External Markdown](#external-markdown)
- - [Element Attributes](#element-attributes)
- - [Slide Attributes](#slide-attributes)
-- [PDF Export](#pdf-export)
-- [Theming](#theming)
-- [Speaker Notes](#speaker-notes)
- - [Share and Print Speaker Notes](#share-and-print-speaker-notes)
- - [Server Side Speaker Notes](#server-side-speaker-notes)
-- [Multiplexing](#multiplexing)
-- [MathJax](#mathjax)
-- [License](#license)
-
-#### More reading
-
-- [Changelog](https://github.com/hakimel/reveal.js/releases): 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.
-- [Plugins](https://github.com/hakimel/reveal.js/wiki/Plugins,-Tools-and-Hardware): A list of plugins that can be used to extend reveal.js.
-
-
-## 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 [https://slides.com](https://slides.com?ref=github).
-
-
-## Installation
-
-The **basic setup** is for authoring presentations only. The **full setup** gives you access to all reveal.js features and plugins such as speaker notes as well as the development tasks needed to make changes to the source.
-
-### Basic setup
-
-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.
-
-1. Download the latest version of reveal.js from After 2 seconds the first fragment will be shown.
-After 10 seconds the next fragment will be shown.
-Now, the fragment is displayed for 2 seconds before the next slide is shown.
-
-
-#### Navigation Mode
-You can fine tune the reveal.js navigation behavior by using the `navigationMode` config option. Note that these options are only useful for presentations that use a mix of horizontal and vertical slides. The following navigation modes are available:
-
-| Value | Description |
-| :--------------------------- | :---------- |
-| default | Left/right arrow keys step between horizontal slides. Up/down arrow keys step between vertical slides. Space key steps through all slides (both horizontal and vertical). |
-| linear | Removes the up/down arrows. Left/right arrows step through all slides (both horizontal and vertical). |
-| grid | When this is enabled, stepping left/right from a vertical stack to an adjacent vertical stack will land you at the same vertical index.
-
-
- elements
- { src: ’plugin/highlight/highlight.js’, async: true },
-
- // Zoom in and out with Alt+click
- { src: ’plugin/zoom-js/zoom.js’, async: true },
-
- // Speaker notes
- { src: ’plugin/notes/notes.js’, async: true },
-
- // MathJax
- { src: ’plugin/math/math.js’, async: true }
- ]
-});
-```
-
-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
-
-You can also include dependencies which are bundled/already present on the page. To include a bundled plugin. replace the `src` property with a reference to a `plugin` instance:
-- **plugin**: the plugin instance (see [Plugins](#plugins))
-
-### API
-
-The `Reveal` object exposes a JavaScript API for controlling navigation and reading state:
-
-```javascript
-// Navigation
-Reveal.slide( indexh, indexv, indexf );
-Reveal.left();
-Reveal.right();
-Reveal.up();
-Reveal.down();
-Reveal.prev();
-Reveal.next();
-Reveal.prevFragment();
-Reveal.nextFragment();
-
-// Randomize the order of slides
-Reveal.shuffle();
-
-// Toggle presentation states, optionally pass true/false to force on/off
-Reveal.toggleOverview();
-Reveal.togglePause();
-Reveal.toggleAutoSlide();
-
-// Shows a help overlay with keyboard shortcuts, optionally pass true/false
-// to force on/off
-Reveal.toggleHelp();
-
-// Change a config value at runtime
-Reveal.configure({ controls: true });
-
-// Returns the present configuration options
-Reveal.getConfig();
-
-// Fetch the current scale of the presentation
-Reveal.getScale();
-
-Reveal.getComputedSlideSize(); // Returns object with width, height keys, and (scaled) presentationWidth and presentationHeight.
-
-// Retrieves the previous and current slide elements
-Reveal.getPreviousSlide();
-Reveal.getCurrentSlide();
-
-Reveal.getIndices(); // { h: 0, v: 0, f: 0 }
-Reveal.getSlidePastCount();
-Reveal.getProgress(); // (0 == first slide, 1 == last slide)
-Reveal.getSlides(); // Array of all slides
-Reveal.getTotalSlides(); // Total number of slides
-
-// Returns an array with all horizontal/vertical slides in the deck
-Reveal.getHorizontalSlides();
-Reveal.getVerticalSlides();
-
-// Checks if the presentation contains two or more
-// horizontal/vertical slides
-Reveal.hasHorizontalSlides();
-Reveal.hasVerticalSlides();
-
-// Returns the speaker notes for the current slide
-Reveal.getSlideNotes();
-
-// State checks
-Reveal.isFirstSlide();
-Reveal.isLastSlide();
-Reveal.isOverview();
-Reveal.isPaused();
-Reveal.isAutoSliding();
-
-// Returns the top-level DOM element
-Reveal.getRevealElement(); // ...
-```
-
-### Custom Key Bindings
-
-Custom key bindings can be added and removed using the following Javascript API. Custom key bindings will override the default keyboard bindings, but will in turn be overridden by the user defined bindings in the ``keyboard`` config option.
-
-```javascript
-Reveal.addKeyBinding( binding, callback );
-Reveal.removeKeyBinding( keyCode );
-```
-
-For example
-
-```javascript
-// The binding parameter provides the following properties
-// keyCode: the keycode for binding to the callback
-// key: the key label to show in the help overlay
-// description: the description of the action to show in the help overlay
-Reveal.addKeyBinding( { keyCode: 84, key: 'T', description: 'Start timer' }, () => {
- // start timer
-} )
-
-// The binding parameter can also be a direct keycode without providing the help description
-Reveal.addKeyBinding( 82, () => {
- // reset timer
-} )
-```
-
-This allows plugins to add key bindings directly to Reveal so they can
-
-* make use of Reveal's pre-processing logic for key handling (for example, ignoring key presses when paused); and
-* be included in the help overlay (optional)
-
-### Slide Change Events
-
-A `slidechanged` event is fired each time the slide is changed. The event object holds the index values of the current slide as well as a reference to the previous and current slide DOM 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.
-
-```javascript
-Reveal.on( 'slidechanged', event => {
- // event.previousSlide, event.currentSlide, event.indexh, event.indexv
-} );
-```
-
-The `slidechanged` event fires instantly when the slide changes. If you'd rather invoke your event listener when the slide has finished transitioning and is fully visible, you can use the `slidetransitionend` event. The `slidetransitionend` event includes the same event data as described above.
-
-```javascript
-Reveal.on( 'slidetransitionend', event => console.log( event.currentSlide ) );
-```
-
-### 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.
-
-```javascript
-Reveal.slide( 1 );
-// we're on slide 1
-
-var state = Reveal.getState();
-
-Reveal.slide( 3 );
-// we're on slide 3
-
-Reveal.setState( state );
-// we're back on slide 1
-```
-
-### Slide States
-
-If you set `data-state="somestate"` on a slide ``, "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.on( 'somestate', () => {
- // TODO: Sprinkle magic
-}, false );
-```
-
-### Slide Visibility
-When preparing a presentation it can sometimes be helpful to prepare optional slides that you may or may not have time to show. This is easily done by appending a few slides at the end of the presentation, however this means that the reveal.js progress bar and slide numbering will hint that there are additional slides.
-
-To "hide" those slides from reveal.js' numbering system you can add a `data-visibility` attribute to the slide like so ``.
-
-### 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 `` elements. Four different types of backgrounds are supported: color, image, video and iframe.
-
-#### Color Backgrounds
-
-All CSS color formats are supported, including hex values, keywords, `rgba()` or `hsl()`.
-
-```html
-
- Color
-
-```
-
-#### Image Backgrounds
-
-By default, background images are resized to cover the full page. Available options:
-
-| Attribute | Default | Description |
-| :------------------------------- | :--------- | :---------- |
-| data-background-image | | URL of the image to show. GIFs restart when the slide opens. |
-| data-background-size | cover | See [background-size](https://developer.mozilla.org/docs/Web/CSS/background-size) on MDN. |
-| data-background-position | center | See [background-position](https://developer.mozilla.org/docs/Web/CSS/background-position) on MDN. |
-| data-background-repeat | no-repeat | See [background-repeat](https://developer.mozilla.org/docs/Web/CSS/background-repeat) on MDN. |
-| data-background-opacity | 1 | Opacity of the background image on a 0-1 scale. 0 is transparent and 1 is fully opaque. |
-
-```html
-
- Image
-
-
- This background image will be sized to 100px and repeated
-
-```
-
-#### Video Backgrounds
-
-Automatically plays a full size video behind the slide.
-
-| Attribute | Default | Description |
-| :--------------------------- | :------ | :---------- |
-| data-background-video | | A single video source, or a comma separated list of video sources. |
-| data-background-video-loop | false | Flags if the video should play repeatedly. |
-| data-background-video-muted | false | Flags if the audio should be muted. |
-| data-background-size | cover | Use `cover` for full screen and some cropping or `contain` for letterboxing. |
-| data-background-opacity | 1 | Opacity of the background video on a 0-1 scale. 0 is transparent and 1 is fully opaque. |
-
-```html
-
- Video
-
-```
-
-#### Iframe Backgrounds
-
-Embeds a web page as a slide background that covers 100% of the reveal.js width and height. The iframe is in the background layer, behind your slides, and as such it's not possible to interact with it by default. To make your background interactive, you can add the `data-background-interactive` attribute.
-
-```html
-
- Iframe
-
-```
-
-Iframes are lazy-loaded when they become visible. If you'd like to preload iframes ahead of time, you can append a `data-preload` attribute to the slide ``. You can also enable preloading globally for all iframes using the `preloadIframes` configuration option.
-
-#### Background Transitions
-
-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 properties below when initializing reveal.js (the other two are optional).
-
-```javascript
-Reveal.initialize({
-
- // Parallax background image
- parallaxBackgroundImage: '', // e.g. "https://s3.amazonaws.com/hakim-static/reveal-js/reveal-parallax-1.jpg"
-
- // Parallax background size
- parallaxBackgroundSize: '', // CSS syntax, e.g. "2100px 900px" - currently only pixels are supported (don't use % or auto)
-
- // Number of pixels to move the parallax background per slide
- // - Calculated automatically unless specified
- // - Set to 0 to disable movement along an axis
- parallaxBackgroundHorizontal: 200,
- parallaxBackgroundVertical: 50
-
-});
-```
-
-Make sure that the background size is much bigger than screen size to allow for some scrolling. [View example](http://revealjs.com/?parallaxBackgroundImage=https%3A%2F%2Fs3.amazonaws.com%2Fhakim-static%2Freveal-js%2Freveal-parallax-1.jpg¶llaxBackgroundSize=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:
-
-```html
-
- This slide will override the presentation transition and zoom!
-
-
-
- Choose from three transition speeds: default, fast or slow!
-
-```
-
-You can also use different in and out transitions for the same slide:
-
-```html
-
- The train goes on …
-
-
- and on …
-
-
- and stops.
-
-
- (Passengers entering and leaving)
-
-
- And it starts again.
-
-```
-You can choose from `none`, `fade`, `slide`, `convex`, `concave` and `zoom`.
-### 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 (``):
-
-```html
-Link
-Link
-```
-
-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
-
-
-
-
-
-
-```
-
-### 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://revealjs.com/#/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:
-
-```html
-
- grow
- shrink
- strike
- fade-out
- fade-up (also down, left and right!)
- fades in, then out when we move to the next step
- fades in, then obfuscate when we move to the next step
- blue only once
- highlight-red
- highlight-green
- highlight-blue
-
-```
-
-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.
-
-```html
-
-
- I'll fade in, then out
-
-
-```
-
-The display order of fragments can be controlled using the `data-fragment-index` attribute.
-
-```html
-
- Appears last
- Appears first
- Appears second
-
-```
-
-### 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.
-
-```javascript
-Reveal.on( 'fragmentshown', event => {
- // event.fragment = the fragment DOM element
-} );
-Reveal.on( 'fragmenthidden', event => {
- // event.fragment = the fragment DOM element
-} );
-```
-
-### Code Syntax Highlighting
-
-By default, Reveal is configured with [highlight.js](https://highlightjs.org/) for code syntax highlighting. To enable syntax highlighting, you'll have to load the highlight plugin ([plugin/highlight/highlight.js](plugin/highlight/highlight.js)) and a highlight.js CSS theme (Reveal comes packaged with the Monokai themes: [lib/css/monokai.css](lib/css/monokai.css)).
-
-```javascript
-Reveal.initialize({
- // More info https://github.com/hakimel/reveal.js#dependencies
- dependencies: [
- { src: 'plugin/highlight/highlight.js', async: true },
- ]
-});
-```
-
-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.
-
-```html
-
-
-(def lazy-fib
- (concat
- [0 1]
- ((fn rfib [a b]
- (lazy-cons (+ a b) (rfib b (+ a b)))) 0 1)))
-
-
-```
-
-#### Line Numbers & Highlights
-
-To enable line numbers, add `data-line-numbers` to your `` tags. If you want to highlight specific lines you can provide a comma separated list of line numbers using the same attribute. For example, in the following example lines 4 and 8-11 are highlighted:
-
-```html
-
-import React, { useState } from 'react';
-
-function Example() {
- const [count, setCount] = useState(0);
-
- return (
-
- You clicked {count} times
-
-
- );
-}
-
-```
-
-
-
-#### Step-by-step Highlights
-
-You can step through multiple code highlights on the same code block. Delimit each of your highlight steps with the `|` character. For example `data-line-numbers="1|2-3|4,6-10"` will produce three steps. It will start by highlighting line 1, next step is lines 2-3, and finally line 4 and 6 through 10.
-
-
-
-### Slide number
-
-If you would like to display the page number of the current slide you can do so using the `slideNumber` and `showSlideNumber` configuration values.
-
-```javascript
-// Shows the slide number using default formatting
-Reveal.configure({ slideNumber: true });
-
-// Slide number formatting can be configured using these variables:
-// "h.v": horizontal . vertical slide number (default)
-// "h/v": horizontal / vertical slide number
-// "c": flattened slide number
-// "c/t": flattened slide number / total slides
-Reveal.configure({ slideNumber: 'c/t' });
-
-// You can provide a function to fully customize the number:
-Reveal.configure({ slideNumber: slide => {
- // Ignore numbering of vertical slides
- return [ Reveal.getIndices( slide ).h ];
-}});
-
-// Control which views the slide number displays on using the "showSlideNumber" value:
-// "all": show on all views (default)
-// "speaker": only show slide numbers on speaker notes view
-// "print": only show slide numbers when printing to PDF
-Reveal.configure({ showSlideNumber: 'speaker' });
-```
-
-### 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:
-
-```javascript
-Reveal.on( 'overviewshown', event => { /* ... */ } );
-Reveal.on( 'overviewhidden', event => { /* ... */ } );
-
-// Toggle the overview mode programmatically
-Reveal.toggleOverview();
-```
-
-### 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
-
-Add `data-autoplay` to your media element if you want it to automatically start playing when the slide is shown:
-
-```html
-
-```
-
-If you want to enable or disable autoplay globally, for all embedded media, you can use the `autoPlayMedia` configuration option. If you set this to `true` ALL media will autoplay regardless of individual `data-autoplay` attributes. If you initialize with `autoPlayMedia: false` NO media will autoplay.
-
-Note that embedded HTML5 `