README.md

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 C++ presentation here src.

Authors:

• Gabriel Nützi and
• Simon Spörri.

Current revealjs version: 4.6.1

Requirements

Using nix

You can enter a development shell with

nix develop ./nix#default

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

DevContainer

There is a .devcontainer which lets you run code or CLI run the project inside. 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
• inotifywait
• npm
• yarn

Usage

1. just init -> Init the build folder with the pinned reveal.js source and inject some changed files (styles, fonts, etc.) and install dependencies inside the build folder.

2. just watch -> Watch the files in src and synchronize changes to the build folder. This is needed to continuously update your changes source files and make the browser reload the page.

3. just present -> Serve the presentation in the browser and continuously reload the page.

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

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