Skip to content

Repository files navigation

Reproducible project template

A template for reproducible slides with Quarto, GitHub Actions, and GitHub Pages.

Live demo: https://robinlovelace.github.io/reproducible-project-template/slides.html

Deploy status

Quick start

(Note: The commands below use the GitHub CLI (gh). If you don't have it installed, you can follow the installation instructions or create the repository manually on GitHub).

gh repo create my-slides --template robinlovelace/reproducible-project-template
cd my-slides
# Enable Pages: Settings → Pages → Source: Deploy from a branch → Branch: gh-pages, / (root)
# Edit slides.qmd, then push
git push

Your slides are live in ~30 seconds.

Features

Feature Description
clean-revealjs theme Bundled in _extensions/, zero install needed
Auto-deploy peaceiris/actions-gh-pages@v4 on every push to main, publishes to gh-pages branch
Auto-detect Uses quarto inspect to detect R/Python needs; only installs what's required
PR previews Deploy preview versions for review before merging
Quarto freeze Cache computation results locally; CI only re-renders markdown
Self-contained HTML Offline-capable HTML with all images, CSS, and JS embedded
PDF export Auto-generated via DeckTape on every release
Date-based releases Automatic versioned releases on every push
Citation support references.bib ready for bibliographies

Workflows

Workflow Trigger What it does
publish.yml Push to main Render site → deploy to GitHub Pages (gh-pages branch)
release-standalone.yml Push to main Build self-contained HTML + PDF → create dated release
pr-preview.yml PR to main Build preview → deploy to temporary URL

Structure

├── slides.qmd                  # Main slide deck
├── index.qmd                   # Landing page
├── _quarto.yml                 # Project config (output-dir, freeze, navbar)
├── references.bib              # Bibliography
├── _extensions/clean/          # clean-revealjs theme (bundled)
└── .github/workflows/
    ├── publish.yml             # Render + deploy to Pages
    ├── release-standalone.yml  # Self-contained HTML + PDF release
    └── pr-preview.yml          # PR preview deployments

Built with this template

About

Flexible repo template for reproducible slides with Quarto and continuous deployment via GitHub actions

Topics

Resources

Stars

13 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages