Publishing on GitHub

(this is just the home page rendered as slides instead)

This is a Quarto Template for Course Websites

Repository Contents

  • _quarto.yml controls the structure of the website (e.g., navigation tabs)

  • index.qmd is home page content

  • syllabus.qmd is a template syllabus

  • syllabus-insert.qmd is boilerplate* content to include in all syllabi (keeping it a separate file makes it easier to update when new guidance comes out)

  • assignments.qmd is a template assignment guide

  • /slides/ is a folder for slide decks

    • day1.qmd is a template Revealjs slide deck

    • ford.scss gives slides a Ford School logo background

    • weill.scss gives slides a Weill Hall background (see, e.g., day1 slides)

    • index.qmd automatically indexes slide decks in the slides folder on the slides tab of the website

  • accessibility.qmd is a page of accessibility tips

  • michigan.scss styles all web pages, documents, and slides based on font and color guidance from the University of Michigan (see HTML Theming for other options)

  • code/copy syllabus template insert to other courses.R is R code to copy files to other course folders

  • assets/accessiblity-fixes.js is JavaScript that fixes accessibly issues with web pages and HTML slides (see accessibly page)

  • /docs/ is where files are rendered when Quarto builds the website — ⚠️ DON’T EDIT IT MANUALLY ⚠️

  • .gitignore is a list of files to ignore (i.e., to not track or publish)

*This particular boilerplate language is from the “Ford School Syllabus Template AY 2025-26.docx” Google Drive file downloaded as Markdown.

How to publish for free on GitHub

1. Make a GitHub account

2. On https://github.com/judgelord/PP000, click Use this template

Name this new repository whatever you want the course website address to be (e.g., “PP475”)

3. Download as a version-controlled project

In RStudio: “New Project”–> “Version Control”

4. Add your content to syllabus.qmd, assignments.qmd, and (optionally) the slides folder

5. Build/render your new website!

In RStudio: “Build” –> “Render Project” (the button may say “Render Website” instead)

6. Commit any changes and push them to GitHub

Note: For the website, you only need to push changes to the /docs/ folder. Add other files only if you want to track changes. Don’t push large files to GitHub.

In RStudio: select changes/files to commit on the “Git” tab. Then push the changes.

(If you don’t already use GitHub, you will need to authorize/authenticate your computer to push changes to GitHub via a personal access token)

7. In GitHub Settings –> Pages, publish from the /docs/ folder