reveal

A framework for easily creating beautiful web-based presentations. Check out the live demo.

Note: This repository was forked from hakimel/reveal.js on 3/11/2019 to continue active development and feature contributions to reveal.js. This fork is published on npmjs under the @h3 scope. See CONTRIBUTING for info on how to join HackerHappyHour and contribute!

@h3/reveal Roadmap:

The goal of @h3/reveal moving forward is to make it easier to use for non-developers and developers alike by modernizing how reveal is distributed, deployed, extended, and integrated.

Our most important goals are currently tracked in our projects and milestones. In particular the v2 milestone looks to pull as many existing PR's from the upstream project as possible, and bring the reveal project up to speed with modern tooling, api design, and front-end features.

If you have an existing Pull Request open at hakimel/reveal.js and would like to review the status of our review of your PR, check out the Review Upstream Pull Requests board. Our process for reviewing pull requests from hakimel/reveal.js is documented in our CONTRIBUTING.md.

---

reveal.js comes with a broad range of features including nested slides, Markdown contents, PDF export, speaker notes and a JavaScript API. There's also a fully featured visual editor and platform for sharing reveal.js presentations at slides.com.

Table of contents

• Online Editor
• Installation
  • Basic setup
  • Full setup
  • Folder Structure
• Instructions
• License

More reading

• Changelog: Up-to-date version history.
• Examples: Presentations created with reveal.js, add your own!
• Browser Support: Explanation of browser support and fallbacks.
• Plugins: 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.

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

Full setup

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 (8.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.

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)

Instructions

Documentation on how to use @h3/reveal can be found at the @h3/reveal docs site: hackerhappyhour.github.io/reveal.

License

MIT licensed

Copyright (C) 2019 Hakim El Hattab, http://hakim.se Modified work Copyright 2019 Hacker Happy Hour, https://github.com/HackerHappyHour and reveal.js contributors