diff --git a/Gemfile b/Gemfile index 40cd3dd..b289930 100644 --- a/Gemfile +++ b/Gemfile @@ -11,6 +11,8 @@ gem 'webrick' group :jekyll_plugins do gem 'jekyll-github-metadata', '~> 2.16' gem 'jekyll-sitemap' + gem 'jekyll-redirect-from' + gem 'jemoji' gem 'just-the-docs' end diff --git a/Gemfile.lock b/Gemfile.lock index 8d6ed00..846a195 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,6 +1,17 @@ GEM remote: https://rubygems.org/ specs: + activesupport (7.2.0) + base64 + bigdecimal + concurrent-ruby (~> 1.0, >= 1.3.1) + connection_pool (>= 2.2.5) + drb + i18n (>= 1.6, < 2) + logger (>= 1.4.2) + minitest (>= 5.1) + securerandom (>= 0.3) + tzinfo (~> 2.0, >= 2.0.5) addressable (2.8.7) public_suffix (>= 2.0.2, < 7.0) ast (2.4.2) @@ -38,9 +49,11 @@ GEM descendants_tracker (~> 0.0.1) colorator (1.1.0) concurrent-ruby (1.3.4) + connection_pool (2.4.1) descendants_tracker (0.0.4) thread_safe (~> 0.3, >= 0.3.1) diff-lcs (1.5.1) + drb (2.2.1) dumb_delegator (1.0.0) em-websocket (0.5.3) eventmachine (>= 0.12.9) @@ -57,6 +70,7 @@ GEM ffi (1.17.0-x86_64-darwin) ffi (1.17.0-x86_64-linux-gnu) forwardable-extended (2.6.0) + gemoji (4.1.0) google-protobuf (4.27.3-arm64-darwin) bigdecimal rake (>= 13) @@ -66,6 +80,9 @@ GEM google-protobuf (4.27.3-x86_64-linux) bigdecimal rake (>= 13) + html-pipeline (2.14.3) + activesupport (>= 2) + nokogiri (>= 1.4) http_parser.rb (0.8.0) i18n (1.14.5) concurrent-ruby (~> 1.0) @@ -91,6 +108,8 @@ GEM octokit (>= 4, < 7, != 4.4.0) jekyll-include-cache (0.2.1) jekyll (>= 3.7, < 5.0) + jekyll-redirect-from (0.16.0) + jekyll (>= 3.3, < 5.0) jekyll-sass-converter (3.0.0) sass-embedded (~> 1.54) jekyll-seo-tag (2.8.0) @@ -99,6 +118,10 @@ GEM jekyll (>= 3.7, < 5.0) jekyll-watch (2.2.1) listen (~> 3.0) + jemoji (0.13.0) + gemoji (>= 3, < 5) + html-pipeline (~> 2.2) + jekyll (>= 3.0, < 5.0) json (2.7.2) just-the-docs (0.9.0) jekyll (>= 3.8.5) @@ -121,6 +144,7 @@ GEM matrix (0.4.2) mercenary (0.4.0) mini_mime (1.1.5) + minitest (5.25.1) net-http (0.4.1) uri nokogiri (1.16.7-arm64-darwin) @@ -197,6 +221,7 @@ GEM sawyer (0.9.2) addressable (>= 2.3.5) faraday (>= 0.17.3, < 3) + securerandom (0.3.1) selenium-webdriver (4.23.0) base64 (~> 0.2) logger (~> 1.4) @@ -207,6 +232,8 @@ GEM terminal-table (3.0.2) unicode-display_width (>= 1.1.1, < 3) thread_safe (0.3.6) + tzinfo (2.0.6) + concurrent-ruby (~> 1.0) unicode-display_width (2.5.0) uri (0.13.0) virtus (2.0.0) @@ -231,7 +258,9 @@ DEPENDENCIES faraday-retry (~> 2.2) jekyll (~> 4) jekyll-github-metadata (~> 2.16) + jekyll-redirect-from jekyll-sitemap + jemoji just-the-docs kramdown-parser-gfm rack diff --git a/_schedules/weekly.md b/_calendars/weekly.md similarity index 100% rename from _schedules/weekly.md rename to _calendars/weekly.md diff --git a/_layouts/schedule.html b/_layouts/calendar.html similarity index 100% rename from _layouts/schedule.html rename to _layouts/calendar.html diff --git a/_sass/berkeley/berkeley.scss b/_sass/berkeley/berkeley.scss index 77e25aa..e4987dd 100644 --- a/_sass/berkeley/berkeley.scss +++ b/_sass/berkeley/berkeley.scss @@ -100,9 +100,13 @@ summary { color: $body-lighter-color; } -a[target="_blank"]::after { +a[target="_blank"]:not(.btn)::after { font-family: 'Font Awesome 6 Free'; font-weight: 900; content: "\f08e"; padding: 0 0.25rem; } + +.lecture .subhead { + @extend h3 +} diff --git a/calendar.md b/calendar.md index 3a47537..1435cf7 100644 --- a/calendar.md +++ b/calendar.md @@ -1,12 +1,12 @@ --- layout: page title: Calendar -description: Listing of course modules and topics. -nav_order: 1 +description: Class schedule. +nav_order: 2 --- -# Calendar +# Weekly Calendar -{% for module in site.modules %} -{{ module }} +{% for calendar in site.calendars %} + {{ calendar }} {% endfor %} diff --git a/docs/README.md b/docs/README.md index 1dda179..b056c7a 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,11 +1,31 @@ +--- +title: Documentation +permalink: /docs/ +published: true +layout: page +has_children: true +--- + # Berkeley Class Site -The documentation here is a brief overview for course staff. -Most +{: .important-title } +> Don't Publish These Docs +> +> This folder (`docs/`) is _published_ in the berkeley-class-site repo for readability, and to add as further test cases. It is recommended that you remove `docs/` from you local course websites, or set `published: false` on these files. + +The documentation here is a brief overview for course staff. Most customization should be done by reviewing the [Just the Docs][jtd] documentation. This website is built using [Jekyll][jekyll] and deployed to [GitHub Pages][gh_pages]. When you push to GitHub, the website is automatically compiled and updated. +[jekyll]: https://jekyllrb.com +[gh_pages]: https://pages.github.com +[jtd]: https://just-the-docs.github.io/just-the-docs/ + ## Tasks for each semester: -- [ ] Make a new respository. It is easiest to name it the semester shortcut, like `fa24`. -- [ ] Search the repo for `TODO() +- [ ] Make a new respository. + - Start by clicking "Use Template" on berkeley-class-site" + - It is easiest to name it the semester shortcut, like `fa24`, i.e. the `baseurl` of your website. +- [ ] Search the repo for `TODO(setup)` +- [ ] Copy files from previous semester. +- [ ] More to come. diff --git a/docs/a11y.md b/docs/a11y.md index 6e692db..80e22cb 100644 --- a/docs/a11y.md +++ b/docs/a11y.md @@ -1,3 +1,10 @@ +--- +title: Using A11Y Specs +permalink: /docs/a11y/ +published: true +layout: page +parent: Documentation +--- # Accessibility Specs > Last Updated: _June 2024_ diff --git a/schedule.md b/schedule.md index 39f2220..1115dd5 100644 --- a/schedule.md +++ b/schedule.md @@ -1,12 +1,14 @@ --- layout: page title: Schedule -description: The weekly event schedule. -nav_order: 2 +description: Course topics, lectures, and assignments schedule. + +nav_order: 1 +published: true --- -# Weekly Schedule +# Schedule -{% for schedule in site.schedules %} -{{ schedule }} +{% for module in site.modules %} + {{ module }} {% endfor %} diff --git a/script/README.md b/script/README.md new file mode 100644 index 0000000..6da462a --- /dev/null +++ b/script/README.md @@ -0,0 +1,9 @@ +# Course Scripts + +Use this folder to store custom scripts for your class. + +`script/template/` includes tools provided by the template for your use. You should keep this around. + +## Template Scripts + +There are no working scripts yet. :( diff --git a/script/template/new-semester-site b/script/template/new-semester-site new file mode 100644 index 0000000..e69de29 diff --git a/script/template/sync-template-updates b/script/template/sync-template-updates new file mode 100644 index 0000000..e69de29