berkeley-cdss / berkeley-class-site

A template for Berkeley CS and Data Science Classes
https://berkeley-cdss.github.io/berkeley-class-site/
MIT License
4 stars 4 forks source link
a11y academic-website accessibility jekyll jekyll-theme

Berkeley Class Site

Pages Deploymenta11y specs

A template for UC Berkeley class websites (with a focus on EECS/CS/DS courses).

Installation

Prerequisites:

  1. Fork the repository.
  2. Clone your fork (replace YOUR_GITHUB_USERNAME and YOUR_REPO accordingly).
    git clone git@github.com:YOUR_GITHUB_USERNAME/YOUR_REPO.git
  3. Install dependencies:
    cd YOUR_REPO
    bundle install

Usage

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.

Contributing

See CONTRIBUTING.md for instructions on how to develop this site as part of course staff or if you're interested in contributing to this template repository.

License

MIT