Contributing to the Workshop

Quick Setup

  1. Clone the repository

    git clone https://github.com/yourusername/your-repo-name.git
cd your-repo-name

  2. Install Quarto (if not already installed)

  3. Edit your presentation

    • Modify template.qmd with your content
    • Preview locally: quarto preview template.qmd
    • Render locally: quarto render template.qmd

Customization Guide

Basic Content

  • Update the YAML frontmatter with your details
  • Add slides using ## for main sections and ### for subsections
  • Use standard Markdown syntax for content

Theme Customization

  • Modify colors in _extensions/clean/clean.scss
  • Adjust the $accent and $accent2 variables for your brand colors
  • Customize fonts by updating the Google Fonts import

Advanced Features

  • Add code blocks with syntax highlighting
  • Include images: ![Alt text](image.png)
  • Create columns: Use RevealJS column syntax
  • Add animations: Use RevealJS fragment classes

Deployment

The presentation automatically deploys to GitHub Pages when you push to the main branch. The workflow:

  1. Triggers on push to main
  2. Sets up Quarto environment
  3. Renders the presentation
  4. Deploys to GitHub Pages

PDF Releases

PDF versions of the presentation are automatically generated and attached to GitHub releases:

  1. Automatic Release: Create a version tag (e.g., v1.0.0) to trigger PDF generation and release creation
  2. Manual Release: Use the “Run workflow” button in the Actions tab for the “Build PDF and Create Release” workflow
  3. Generated PDF: The PDF is named workshop_pkpd_antimicrobials.pdf and attached to the release

To create a new release with PDF:

git tag v1.0.0
git push origin v1.0.0

Troubleshooting

Workflow Fails

  • Check that GitHub Pages is enabled in repository settings
  • Ensure the workflow has proper permissions
  • Check the Actions tab for detailed error logs

Local Issues

  • Verify Quarto is installed correctly
  • Check that all image paths are correct
  • Ensure YAML frontmatter is valid

Getting Help