Skip to content

Latest commit

 

History

History
56 lines (37 loc) · 1.81 KB

README.md

File metadata and controls

56 lines (37 loc) · 1.81 KB

Berkeley Class Site

Pages Deployment • a11y specs

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

Installation

Install Ruby and Bundler

The berkeley-class-site template requires Ruby 3.3.7 or higher and bundler >= 2.6 Install Ruby before continuing. You can check your Ruby version by running:

ruby --version
bundle --version

Prerequisites:

  1. Fork the repository.
  2. Clone your fork (replace YOUR_GITHUB_USERNAME and YOUR_REPO accordingly).
git clone [email protected]:YOUR_GITHUB_USERNAME/YOUR_REPO.git
  1. 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