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 (4.0.0 or later)

2. Clone the reveal.js repository

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

3. Navigate to the reveal.js folder

   $ cd reveal.js

4. Install dependencies

   $ npm install

5. Serve the presentation and monitor source files for changes

   $ npm start

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

   You can change the port by using npm start -- --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)

MIT licensed

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