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 browser with support for CSS 3D transforms but fallbacks are available to make sure your presentation can still be viewed elsewhere.

• Installation: Step-by-step instructions for getting reveal.js running on your computer.
• Changelog: Up-to-date version history.
• Examples: Presentations created with reveal.js, add your own!
• Browser Support: Explanation of browser support and fallbacks.

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.

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 https://github.com/hakimel/reveal.js/releases

2. Unzip and replace the example contents in index.html with your own

3. Open index.html in a browser to view it

Some reveal.js features, like external markdown and speaker notes, require that presentations run from a local web server. The following instructions will set up such a server as well as all of the development tasks needed to make edits to the reveal.js source code.

1. Install Node.js

2. Install Grunt

3. Clone the reveal.js repository

   $ git clone https://github.com/hakimel/reveal.js.git

4. Navigate to the reveal.js folder

   $ cd reveal.js

5. Install dependencies

   $ npm install

6. Serve the presentation and monitor source files for changes

   $ grunt serve

7. Open http://localhost:8000 to view your presentation

   You can change the port by using grunt serve --port 8001.

• 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)

Please keep the issue tracker limited to bug reports, feature requests and pull requests. If you are reporting a bug make sure to include information about which browser and operating system you are using as well as the necessary steps to reproduce the issue.

If you have personal support questions use StackOverflow.

• Should follow the coding style of the file you work in, most importantly:
  • Tabs to indent
  • Single-quoted strings
• Should be made towards the dev branch
• Should be submitted from a feature/topic branch (not your master)
• Should not include the minified reveal.min.js file

MIT licensed

Copyright (C) 2014 Hakim El Hattab, http://hakim.se