CSIP @ UGA Homepage

This is the development repo for https://csip-uga.github.io.

Quickstart

This site uses the Jekyll static site generator and is deployed to GitHub pages.

To develop locally, you'll need Ruby and the jekyll and github-pages gems.

# Install Ruby on macOS.
# Substitute your favorite package manager on your favorite OS.
brew install ruby

# On macOS, you may need to reload your shell
# to switch from the system Ruby to Homebrew Ruby.
exec $SHELL

# Install the gems.
gem install jekyll github-pages

# Now you can launch the development server.
# The dev server will automatically rebuild the site as you edit files.
jekyll serve --future

# Publish your changes by pushing push to GitHub.
git commit -am 'Foo the bar'
git push

The following documentation may be useful.

• https://pages.github.com/
• https://help.github.com/categories/customizing-github-pages/
• https://jekyllrb.com/docs/

rebuild.sh

Most of the maintenance tasks below are encapsulated by the rebuild.sh script. Use this script to make a new maintenance commit. If you are satisfied with the results, push to GitHub to publish.

The script expects to run the root of the git repo.

# Create a maintenance commit.
./rebuild.sh

# Publish the changes.
git push

Future Posts

Jekyll will not render pages dated in the future when the site is built. This can be useful for developing problem sets or blog posts. The catch is that you must manually tigger a site rebuild after a page transitions from future to past. To trigger a rebuild, push a new (possibly empty) commit to GitHub:

git commit --allow-empty -m 'Rebuild site'
git push

This task is automatically handled by rebuild.sh.

Adding Problems

We track the CSIP problem archive as a git submodule under the _problems directory, and Jekyll is configured to generate pages from the problem archive automatically. To rebuild the website with the latest problems, simply update the submodule.

# Sync _problems with the master branch of csip-uga/archive.
git submodule update --remote _problems

# Publish the new problems.
git commit _problems -m 'Sync with problem archive'
git push

This task is automatically handled by rebuild.sh.

Sorting the Header

The header of all pages includes a list of top-level pages. These pages are sorted by weight where the heavier pages sink to the end of the list. You can specify the weight of a page in its front matter. The default weight is 10.

Swiss Theme

This site uses the great Swiss Jekyll Theme by @broccolini. The theme is available as open source under the terms of the MIT License.