Skip to content

Latest commit

 

History

History
66 lines (43 loc) · 2.12 KB

README.md

File metadata and controls

66 lines (43 loc) · 2.12 KB

README

Intro

This is a Jekyll template intended to be used as a starting point for creating a course website with the UBC CLF Jekyll Theme in the UBC CS webspace. You can see a working demo here

Quickstart

Local Testing

Requirements:

Enter the following commands in your favourite terminal:

git clone [email protected]:ubc-cpsc/jekyll-course-template.git # clone this repo
cd jekyll-course-template
bundle config set --local path 'vendor/bundle' #
bundle install # install the gems from the Gemfile
bundle exec jekyll serve # build the site and make it available on the local server

Deployment

If you are wanting to host your website in the UBC Computer Science department webspace, please find the full deployment instructions on my.cs.

More on deploying Jekyll websites here.

Adding to Your Course

We use Jekyll Collections to make adding to the course simple. There are 3 items you can add:

  1. Lectures
  2. Assignments
  3. Tutorials

You can also always add your own custom pages in html, or markdown. For more information see the Jekyll Docs.

Adding Lectures

Create a markdown file in the _lectures folder

Add:

  • name
  • description
  • link

You can see _lectures/lecture_1.md as an example. Rebuild the site and the information will be added to the lectures page.

Adding Assignments

Repeat the same steps with _assignments.

Adding Tutorials

Repeat the same steps with _tutorials, plus add material outside of the front matter

This will also create a page at /tutorials/<tutorial_name>.html

You can see _tutorials/tutorial-1.md as an example.