Presentations

This repository hosts presentations made using the reveal.js framework. Presentations stores other kinds of presentations, plus images and videos since I don't want them here. This is really just markdown files rendered in a nice way.

Usage

Fork

It should be quite straight forward to use this for your own presentations. Just fork the repo and make some new markdown files, preferably on the format YYYY-MM-DD-title.md.

Install

Installing all dependencies is done with

npm install

Run locally

You can start a locally hosted site that will be available at http://localhost:1948 with

npm run start

Publish

Pushing to GitHub will run a workflow that places the static site in the root of the gh-pages branch.

If you for some reason want to build it manually, you can, with

npm run build

This will put the static site in the docs directory.

Static site YAML fields

The YAML fields that are used for the list view on the built static site are

hidden: false
author: Your Name
title: My Title
event: Cool Event
date: "2023-01-17"

None need to be given, and while most have the effect of the text being shown in the list view, hidden: true will instead make sure the slide is not listed (it will, however, be created as a site just as any other slide).

Plugins

See an example demo of all features with source and built site.

In addition to the default plugins provided by reveal-md, the following plugins are included in this project:

• reveal.js-elapsed-time-bar

  The timer is triggered by setting

  revealOptions:
    allottedTime: 900000

  in the YAML front matter, where time is in milliseconds. The example above will give a timer that takes 15 minutes.

• revealjs-animated

• reveal.js-copycode

• reveal-drawer

• reveal-pointer

• reveal.js-attribution

• reveal.js-fullscreen

• QR-code

There is also support for font-awesome icons, which can be searched for here.

Project specifics

This project makes a few changes to the original packages reveal.js and reveal-md. These patches are made using the patch-package module:

npx patch-package reveal-md
npx patch-package reveal.js

Thus, if you want further changes from this project or other modules, this is done simply by changing the source files and running npx patch-package some-package.

Licenses

The source code of the website and main repository itself is licensed under the MIT license.

The content of the content directory is licensed under the CC0 1.0 Universal license, which can be found here.