DEV Community

loading...

How to Package and publish your RevealJS presentation

Abdelrhman Safwat
・2 min read

This article was originally published on my personal blog.
...
A while ago I was asked to give a presentation to my teammates at work on React. I've always been fascinated by the way most people give presentations at talks which made me research how to do them. The absolute winner was RevealJS.

A couple of things made me prefer it

  1. The documentation covered all features and aspects
  2. The framework itself contained multiple comprehensive examples covering all use cases which provided an excellent starting point.

As mentioned in the documentation the best way to install and use the framework is by cloning the repo using this command
$ git clone https://github.com/hakimel/reveal.js.git
The nice thing about cloning the whole repo is that you get a complete examples folders showcasing the features and a demo presentation which I considered RevealJS Holy Grail, I would lie if I didn't say that my whole presentation styles is copied from the demo presentation.
RevealJS uses gulp for building and developing.
One hidden feature I stumbled upon while going through the gulpfile was a task called package where you can build and package your presentation and voila it's ready for publishing. sadly when I tried it out, it didn't work as expected so I had to make a few changes. The thing is it captures all the framework files and your index.html; which contains your presentation; and creates a packaged zip file ready for publishing. If you try the published version you will find out it's broken and that's because all the references inside your index.html don't point to the correct locations. Hence, you're left with one of 2 options, either to update all css and js references in the published index, or modify the package task to add files with the correct folder structure, which was what I did.

The gulp task copied only the internal files/folders without copying the parent folder due to a bug in writing down the folders paths, it was defined as

gulp.task('package', gulp.series('default', () =>
    gulp.src([
        './index.html',
        './dist/**',
        './plugin/**',
        './**.md'
    ]).pipe(zip('reveal-js-presentation.zip')).pipe(gulp.dest('./'))
))

But since we also wanted the respected dist & plugin parent folders as well, we need to change the path to be wild card instead of a specific location. So the updated version will be

gulp.task(
  "package",
  gulp.series("default", () =>
    gulp
      .src([
        "index.html",
        "*dist/**/*",
        "*media/**/*",
        "*plugin/**/*",
        "*markdown/**/*",
      ])
      .pipe(zip("reveal-js-presentation.zip"))
      .pipe(gulp.dest("./"))
  )
);

I also included a couple more folders where I organized my files.

Now the last thing to do is to update the package.json file to include a package script by adding the line "package": "gulp package" and run the command npm run package after the task is finished you will find a zip file called reveal-js-presentation.zip created containing your presentation and ready for publishing anywhere.

Discussion (0)