a.wagner/ISC-tutorial
1
0
Fork 0
Code Pull requests Packages Activity
ISC-tutorial/README.md
Andreas Knüpfer 1835e8d042 Update instructions
2026-04-02 10:12:35 +02:00

3.1 KiB
Raw Permalink Blame History

CASUS Presentation Template based on Reveal.JS

This is the CASUS slide template for presentations based on Reveal.JS

Install First time

To get started for the first time with this template clone this repository:

git clone git@codebase.helmholtz.cloud:casus/casus-slides-template-revealjs.git first_casus_revealjs_slide_deck

then

cd first_casus_revealjs_slide_deck/

This repository contains all the CASUS specific parts. It needs an upstream version of reveal.js which can be installed in two ways. For the first time you should install it as a submodule

git submodule add https://github.com/hakimel/reveal.js.git

and don't follow their installation instructions.

Then start the local webserver to serve the slides to your local webbrowser via

./server.py

TODO: Add installation instructions for Python modules, try first if they are available from packages already to avoid many .venv/ ending up in the user's home.

Install for following slide decks

For following slide decks of yours there are different ways:

  1. Either clone again to another directory like

    git clone git@codebase.helmholtz.cloud:casus/casus-slides-template-revealjs.git second_slide_deck cd second_slide_deck/

  2. Make a branch in the existing repo

    cd first_casus_revealjs_slide_deck git checkout -b second_slide_deck

and later use git switch to change between the branches with the different slide decks.

  1. Create a git worktree from the previous clone (preferred way if you are comfortable with git worktrees)

    cd first_casus_revealjs_slide_deck git worktree add ../second_slide_deck cd ../second_slide_deck

In case 1) and 3) you should add reveal.js as a symlink to the existing version. From within second_slide_deck/ call

ln -s ../first_casus_revealjs_slide_deck/reveal.js .

Another version of reveal.js as a submodule would also work but this would produce many redundant copies of reveal.js over time. Case 2) doesn't need anything else.

Then run

./server.py

the same way as above.

Reveal.JS

This is a presentation theme for CASUS based on

reveal.js

Suggested way to organize your slides

  • Make your personal fork of this project on HZDR GitLab at https://codebase.helmholtz.cloud/casus/revealjs-casus-template
  • Clone it and make a branch for each slide deck. The main branch keps the example slide deck forever.
  • Keep your slide decks in different branches in your fork. This means those branches are never meant to be merged to main.
  • If you want to switch to a different slide deck, switch to that branch.
  • If you want to have several slide decks accessible at the same time, use git worktrees.
  • When the CASUS template gets updated, sync the main branch in your fork. Then you can selectively merge those changes to one/some/all of your branches. Old slide decks should stay in their branch without changes and just stay with the old versions to the template so that nothing breaks.