Technical Presentation

Make technical presentations in Markdown/HTML etc.

This uses revealjs with some modifications to package to PDF and standalone HTML format. Also it includes a company scss file for design modifications.

• See the demo presentation here.
• See some other Rust Workshop [src].
• See some other C++ presentation here [src].

Authors:

• Gabriel Nützi and

Warning

This is the pandoc tooling branch, if you want a simpler version with reveal.js only, use main-simple.

Current revealjs version: 4.6.1

Requirements

Using nix

You can enter a development shell with

nix develop './tools/nix#default'

where all requirements are installed to start working on your first presentation.

DevContainer

There is a .devcontainer to be run over code or the devcontainer CLI. First build the container:

just build-dev-container

or with docker instead of podman:

just container_mgr=docker build-dev-container

Manual

You need the following tools:

• bash
• just
• rsync
• watchman
• npm
• yarn

Usage

1. just serve -> Launches process-compose to initialize/watch and present the presentation. You can edit and see the changes on-the-fly on http://localhost:3000.

2. just package -> Export the presentation as HTML and PDF inside a .zip file to the publish folder.

3. just publish -> Build and upload the (selected) presentation to the publish branch in the folder docs/gh-pages which can then be served by Github pages. The .publish.yaml helps in defining the name and output folder in docs/gh-pages to host multiple presentations alongside.

Make a Presentation

• Write your presentation in Markdown in src/presentations. All images and other assets needed by the presentation should go into the respective assets directory (e.g. presentation-1/assets)

Resources

Check the following resources with additional slide materials:

• Documentation
• Markdown from a C++ presentation View

Modifications

• Edit the design in company.scss.

• Company Logo: Edit the file company-logo.svg.

  • Replace embedded image in company.scss with

  just bake-logo