Reveal.js with Vite

Minimal reveal.js scaffolding using vite.

Using the reveal.js API rather than a clone of the reveal.js repo (which is their recommended installation, but not preferred by the creators of this repo).

eScience Center styling

This template includes default styling with Netherlands eScience Center branding. This consists of two main components:

• nlesc-decorations.js: a reveal.js plugin that inserts some elements into the slide deck on load.
• nlesc-decorations.scss: a custom reveal.js theme which modifies some of the default styles, and styling for above decorations. They are out-of-view by default, but will respond to class changes set through the data-state attribute in a reveal section. These styles are imported in the custom theme, so they are meant to be used together.

The plugin and theme are imported in the default reveal.js entrypoint, in this case main.js. If you are using reveal.js in another way, e.g. through an index.html file, you can import them there.

To use as template

Click the button "Use this template". This will create a copy of this repository in your own github account. Give your new repo a suitable name. Subsequently, to edit and preview:

git clone <your new repo>
cd <your repo name>
yarn

# Modify package.json:
# change the name field to the name you chose for your repo

# To start a development server
yarn dev

# To build for production / GH pages
yarn build