RevealExpress
ExpressJS server to show your RevealJS presentation and add interaction with your audience
What is RevealExpress
Start revealexpress inside your presentation folder, share the URL with your audience and start your interactive presentation.
Instructions
1 - Install RevealExpress globally
You must have NodeJS and NPM already installed. In your console, run:
(You may need to add sudo
at start)
npm install -g revealexpress
2 - Launch RevealExpress inside your presentation folder
In your console, navigate to your project folder. Then launch RevealExpress:
cd ./my-awesome-presentation
revealexpress
RevealExpress should open in your default browser and build a presentation based on your HTML files.
3 - Share the URL with your audience
Simply share the URL that should appear and your audience will have access to your presentation through RevealExpress. By default, you must be on the same network.
Features
- Work in any modern browser
- Open in default browser
- Accessible by anyone on the same network
- Audience can follow your presentation in real time
Additional features
PrismJS
You can include PrismJS in your slideshow using Webpack and babel-plugin-prismjs.
Configuration
Command arguments
You can pass arguments to the revealexpress
command to customize the slideshow:
revealexpress -n="My slideshow" -p=5000 --revealjs.slideNumber=0
You can use the --help
flag to list every available arguments:
revealexpress --help
You can also use a JavaScript file to send arguments to RevealExpress:
module.exports = {
name: 'My slideshow',
port: 5000,
portws: 5001,
revealjs: {
slideNumber: 0
},
stylesheets: ['assets/css/style.css'],
javascripts: ['assets/js/script.js']
};
RevealJS API
RevealJS expose an API to let you listen or trigger events and configure the slideshow.
The Reveal
object is accessible once the slideshow has been loaded. You can listen to the 'loaded' event and then use the Reveal
object within the listener callback function:
document.getElementById('revealexpress').addEventListener('loaded', function(event) {
event.Reveal.next();
});
⚠️ You should always wait for the slideshow to be loaded before interacting with it!
Credits
Development
This project was inspired by the Keppler project.