Teaching Workshops with GitHub Pages

University Libraries Development Day




Phil White

Earth, Environment & Geospatial Librarian

Jan. 28, 2021

outpw.github.io/workshop-template

Agenda


  1. Slides
    • What is GitHub & GitHub Pages?
    • Examples
    • Why use this?

  2. Workshop Template
    • Overview
    • Setting up your own
    • Adding Custom Content

GitHub & GitHub Pages

What is GitHub?

  • GitHub is a code sharing website
  • Create an account!
  • Very popular with people interested in computer programming
  • Super for collaboration
  • Free, and pretty easy (with learning curve)

What is GitHub?

  • Primary purpose is back up & version control
  • Code for a project lives in a "repository"
  • For example...

What is GitHub Pages?

  • GitHub Pages: static webpages hosted on GitHub.
  • Free! Easy configuration!
  • Add webpages and associated content to a repo...
  • ...click a couple of buttons...
  • ...and BAM! you have a website.

Don't want to deal with HTML/CSS/JS?


No problem!


Enter JEKYLL

Jekyll

  • Static sites generator
  • Lots of templates
  • Transforms Markdown docs to sites
  • GitHub Pages are powered by Jekyll
  • Once deployed, create new pages using Markdown

How does Phil use GitHub Pages?

Examples:

Why should I use this?

  • Put your workshop docs online.
  • It's
  • It's open!
  • It's highly customizable.
  • It's easy!

This whole site is a template!

repo here

Let's check it out!