Skip to content

circadia-bio/SlidesTemplate

Repository files navigation

🎞️ SlidesTemplate

Circadia Lab Quarto/RevealJS presentation template.

License: MIT Quarto


📖 What is this?

A ready-to-use Quarto RevealJS slide template matching the Circadia Lab visual identity — Playfair Display headings, Alice body text, navy/coral/cream colour palette, and the split-panel cover slide.

Clone or use as a GitHub template to start a new presentation in seconds. Every push to main automatically re-renders the slides and publishes them to a public GitHub Pages URL — no manual export required.


🚀 Quick start

# 1. Click "Use this template" on GitHub and name your new repo
# 2. Clone it
git clone https://github.com/circadia-bio/YOUR-REPO-NAME.git
cd YOUR-REPO-NAME

# 3. Edit the params block at the top of index.qmd
# 4. Preview locally
quarto preview index.qmd

# 5. Commit and push — slides deploy automatically
git add -A
git commit -m "✨ feat: initial slide content"
git push

See guide/getting-started.md for a full step-by-step guide.


🗂️ Structure

SlidesTemplate/
├── index.qmd                 # ⭐ Your presentation — edit this
├── custom.scss               # Circadia Lab theme (fonts, colours, layout)
├── _quarto.yml               # Quarto project config
├── SlidesTemplate.Rproj      # RStudio project file
├── assets/
│   ├── cover.png             # Cover slide background
│   ├── circadia_logo.png     # Watermark shown on every content slide
│   └── northumbria.png       # Northumbria University logo on cover
├── .github/
│   └── workflows/
│       └── deploy.yml        # Auto-render + deploy to GitHub Pages
├── guide/
│   ├── getting-started.md    # Full setup and authoring guide
│   ├── slide-reference.md    # All available classes and layouts
│   └── github-pages.md       # How to enable and use GitHub Pages

✨ Features

  • YAML params cover — set title, subtitle, presenter, and event once at the top of the file; the cover slide renders them automatically
  • Cover slide — full-bleed background with right-aligned title, subtitle, presenter, date; footer and logo hidden automatically
  • Content slides — cream background, Playfair Display titles, Alice body, coral em-dash bullets
  • .intro — mid-blue introductory paragraph
  • .cta — coral bold accent line
  • .smaller — scale down font on content-heavy slides
  • Two-column layouts:::: {.columns} with sensible defaults
  • Circadia logo watermark — 35% opacity, auto-hidden on cover
  • Auto-deploy — GitHub Actions renders and publishes on every push

🎨 Colour palette

Token Hex Use
Navy #004474 Titles, primary text
Blue #1B6799 Subtitles, intro text, footer
Coral #FC544A Bullets, bold emphasis, CTAs
Cream #FAEBD7 Slide background

📚 Documentation

Guide What it covers
guide/getting-started.md Installation, first render, params, R packages, renv
guide/slide-reference.md Every class, layout, and formatting option
guide/github-pages.md Enabling Pages, custom domains, troubleshooting

👥 Authors

Role Name
Developer / Researcher Lucas França
Researcher Mario Leocadio-Miguel

🤝 Related Tools

  • 🌙 SleepDiaries — participant-facing sleep diary app
  • 📋 ScoreMe — research questionnaire scorer
  • 🛏 slumbR — R companion for Sleep Diaries exports
  • 🧮 tallieR — R companion for ScoreMe exports
  • 🔬 circadia-bio — the Circadia Lab GitHub organisation

📄 Licence

Released under the MIT License.

Copyright © Circadia Lab — Lucas França & Mario Leocadio-Miguel

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages