Quickstart instructions

[Peter9192]

I tried using this template. It looks awesome, congrats on that!

However, I did have some difficulties getting started. The instructions in the readme point to your repo 'reveal launcher', but in this repo I could not find any documentation about what it is and how it is to be used. To be honest, it looks a bit overkill for what I'm trying to do.

I eventually managed to use this template by:

• Following the reaveal.js installation instructions here,
• Creating a folder called presentations inside my clone of the reveal.js repo,
• Copying the content of this template repo into that presentations folder
• Starting the reveal.js server with npm start
• Navigating in the browser to http://localhost:8000/presentations/

This is perhaps not the best way to do it, but I am not used to working with reveal.js and this is the first approach that worked for me.

Is there a better way to use it? I'm specifically interested in simple solutions, so something like npm install & npm start. Perhaps I can look into it a bit more, but it might be helpful if you can point me in the right direction.

[Peter9192]

I played a bit more and made a very barebones template repository for scaffolding a reveal.js project with vite. What I like about this is that you don't need a copy of the reveal.js repo, so it is very lightweight and easy to work with.

Now working to add custom branding following the instructions as per https://github.com/hakimel/reveal.js/blob/master/css/theme/README.md. I think it should be relatively straightforward to add your custom html/css/javascript to this as well, I'd like to explore that further.

It might also be interesting to expand on this with a component framework, something like https://github.com/rajasegar/svelte-slides.

[OleMussmann]

Hi Peter, great that you started playing with the slides. They are indeed not very usable yet. I'm trying to make some time for structurally working on the house style and the template.

For me the most simple approach is:

• Put the reveal.js repo somewhere on your system
• Symlink the reveal.js folder into your presentation folder
• Have one index.html with everything included
• Start any local webserver in that folder, for example python3 -m http.server
  • N.B. This is simpler than all the npm stuff, but does not have live reload
• Optional: Push the presentation to Github Pages to auto-deploy
  • Example: https://nlesc-slides.github.io/template/
  • Once you make changes, push to a certain branch (in this case publish) and the online presentation will be updated

The reveal launcher is meant to simplify managing different reveal.js versions, different style sheets, and start a web server from one GUI, but it's not ready for prime-time yet.

[Peter9192]

Thanks Ole! I also like the idea of using GH pages. Perhaps a GH action to automatically build and publish to the pages branch would be nice.

I made some progress with using this style. In fact, I converted it to a small reveal.js plugin with some custom scss, which integrates quite nicely with several common reveal.js workflows, I think. I replaced much of the js event-handling code with (s)css. See here for now. Not everything works yet, but I'm getting there.

Perhaps it'd be nice to discuss this in person sometime soon.