Merge pull request #14 from berkeley-eecs/update-config

Update _config.yml, README.md; add resources.md; update just-the-docs to latest version

Gemfile

@@ -2,6 +2,7 @@ source 'https://rubygems.org'
 gem 'github-pages', group: :jekyll_plugins
 gem 'jekyll-sitemap'
 gem 'webrick'
+gem 'just-the-docs'
 
 group :development, :test do
     gem "rspec"

README.md

@@ -28,6 +28,8 @@ To run the site locally, run:
 bundle exec jekyll serve
 ```
 
+Search throughout the repository for TODO items called `TODO(setup)` and complete them to customize the site for your course.
+
 ## Deployment
 
 The easiest way to deploy your site is with [GitHub Pages](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll).

_config.yml

@@ -13,28 +13,38 @@
 # you will see them accessed via {{ site.title }}, {{ site.github_repo }}, and so on.
 # You can create any custom variable you would like, and they will be accessible
 # in the templates via {{ site.myvariable }}.
-title: Just the Class
+title: Berkeley Class Site
 tagline: A Jekyll template for course websites
 description: A modern, highly customizable, responsive Jekyll template for course websites
-author: Kevin Lin
+author: Various Bears
+# TODO(setup): Set this to the semester, e.g. /sp24
 baseurl: '/berkeley-class-site' # the subpath of your site, e.g. /blog
-url: 'https://phrdang.github.io' # the base hostname & protocol for your site, e.g. http://example.com
+# TODO(setup): Set this to your course's domain
+url: 'https://berkeley-eecs.github.io' # the base hostname & protocol for your site, e.g. http://example.com
 plugins:
   - "jekyll-sitemap"
-exclude: ["Gemfile", "Gemfile.lock", "vendor", "node_modules", "LICENSE"]
+
+# Course variables
+# TODO(setup): Set all of these course variables
+course_email: COURSE_EMAIL@berkeley.edu
+gradescope_course_id: 123456 # you can find this in the Gradescope URL after /courses
 
 # Theme settings
-remote_theme: just-the-docs/just-the-docs@v0.5.1
+theme: just-the-docs
 color_scheme: light
 search_enabled: true
 heading_anchors: true
 permalink: pretty
+# TODO(setup): Set these auxiliary links as oyu wish - they show up on the top right
 aux_links:
-  Kevin Lin:
-    - 'https://kevinl.info'
-  Just the Class on GitHub:
-    - 'https://github.com/kevinlin1/just-the-class'
-footer_content:
+  Ed:
+    - 'https://edstem.org'
+  OH Queue:
+    - 'https://oh.c88c.org'
+  Berkeley Class Site on GitHub:
+    - 'https://github.com/berkeley-eecs/berkeley-class-site'
+# TODO(setup): Set copyright/licensing or any other footer content
+footer_content: "Copyright © 2024 UC Berkeley"
 
 # Collections for website data
 collections:
@@ -105,6 +115,11 @@ compress_html:
   blanklines: false
   profile: false
 
-# Course variables
-course_email: cs88@berkeley.edu
-gradescope_course_id: 693229
+# Files excluded from the Jekyll build
+exclude:
+  - "Gemfile"
+  - "Gemfile.lock"
+  - "vendor"
+  - "README.md"
+  - "CONTRIBUTING.md"
+  - "LICENSE"

resources.md

@@ -0,0 +1,11 @@
+---
+layout: page
+title: Resources
+description: >-
+    Course resources
+nav_order: 5
+---
+
+# Resources
+
+Add links to course resources here