Workshop Template

This repository is a template for creating workshop material and slides for coding topics. It comes with a basic structure (README, Makefile) for tooling and a RevealJS slide deck example. The slides are published to GitHub Pages using Quarto.

Here is a workshop based on this example: https://github.com/sagikazarmark/temporal-intro-workshop/

Usage

1. Create a new repo based on this template
2. Clone the repository
3. Install dependencies
   • Option 1 (recommended): Make sure nix and direnv are installed, then run direnv allow
   • Option 2: Install Quarto manually
4. Make changes to slides/index.qmd
5. Run make slides to open the slides in your browser
6. Add your workshop material to the repo (eg. code examples to examples, solutions to solutions)
7. Add some tests to .github/workflows/ci.yaml
8. Fill out the README template below
9. Push changes
10. Enable GitHub Pages in your repository settings

-----DELETE THIS LINE AND ABOVE-----

[YOUR WORKSHOP TITLE]

Prerequisites

Add your prerequisites here For example: Make sure nix and direnv are installed, then run direnv allow

Usage

Adjust the instructions below

1. Checkout this repository
2. Run make up
3. ...

[HOW TO USE THIS REPO]

Add your instructions here

Cleaning up

Once you are finished with the workshop, you can clean up all resources by running the following command:

make down

Development

Add your instructions for working on the workshop material.

Make sure nix and direnv are installed, then run direnv allow.

To work on the slides, run make slides. It will open a browser window and automatically refresh the page when you make changes to the slides.