Using reveal.js for presentations

reveal.js is an open source HTML presentation framework with a lot of built-in capabilities, mature, and capable of producing stunning slides.

The final slides will be HTML, but there are several ways to write your contents. You can always write the HTML markup directly, but there is also the possibility to use other markups that, if you find that more simple to handle, and then use an exporter to transform your contents to HTML.

Using markdown to write your contents

Please refer to the manual for more information on this approach

Using emacs & org to write your contents

Once you have a working installation of emacs on your system, you can install emacs-reveal, and use org markup to write your presentation contents. The repository has a demo that you can leverage to learn how to use this solution. It will be benefitial to check the howto.

From the howto, copy the elisp (it contains the important publish.el file) folder inside your project root folder. You may want to:

  1. Create a public folder that will contain the final HTML file with your presentation.

  2. (shallow) Clone reveal.js source code inside public folder. That will bring some css, javascript files that will help your presentation look (and behave) stunning. You don’t need all the files of this repo, but I haven’t take the time to find out a clean way to get only the minimum necessary.

  3. Generate your website (presentation) with:

    emacs --batch --load elisp/publish.el
  4. Preview your project: firefox public/name-of-your-presentation.html.

I should mention that, if you don’t want to install everything yourself, you can use a docker image (provided by the author of emacs-reveal) ready with all already installed for you, although I haven’t tried myself that option, so I don’t have experience using this.


Date
September 6, 2024