template-workshop: A template for creating Quarto-based workshops

Release Zenodo DOI

Features

• Uses Quarto for the workshop content, allowing for easy integration of code, text, and figures.
• Includes a justfile for managing common tasks like building the workshop and running checks.
• Uses typos to check for common spelling mistakes.
• For R projects, uses Air to format and check R code.
• Uses Commitizen to check commit messages, create the changelog, tag the repository, and create a a GitHub release.
• Uses a CC-BY-4.0 license.
• Run checks with with pre-commit hooks to ensure consistent formatting and style across the project. It includes checks for credentials, typos, and file formatting.
• Uses rostools-theme Quarto extension for a standard appearance across workshops.
• Includes GitHub Actions for continuous integration and delivery for running checks, formatting, releasing, and building the website.
• Uses Netlify for hosting the workshop website, which is automatically built and deployed with Quarto's GitHub Action workflow.
• Includes an EditorConfig file to ensure consistent formatting across different editors.
• Sets some common VS Code settings for the project, including suggesting extensions

Using

This template uses Copier to create a folder with relevant files for a rostools-structured workshop. We use uv to run the commands, so you'll need to install that first. After that, creating a new workshop project folder can be done with:

uvx copier copy gh:rostools/template-workshop WORKSHOP-NAME

Where WORKSHOP-NAME is the name of the folder you want to create. This will copy the template files into that folder, and you can then edit them as needed. When you use it, it will ask you a series of questions to correctly set up the workshop folder.