Follow the installation and usage instructions below for development work on the site and large content changes. Small content changes can easily be made on GitHub.
Rather than using Docker containers (and VSCode's devcontainer extension), instead we will install our project dependencies "locally".
The berkeley-class-site template requires Ruby 3.3.9 or higher and bundler >= 2.6 Install Ruby before continuing. You can check your Ruby version by running:
ruby --version
bundle --versionPrerequisites:
- You have everything that Jekyll requires
- You have installed Bundler: Run
gem install jekyll bundler
- Fork the repository.
- Clone your fork (replace
YOUR_GITHUB_USERNAMEandYOUR_REPOaccordingly).
git clone git@github.com:YOUR_GITHUB_USERNAME/YOUR_REPO.git
- Install dependencies:
cd YOUR_REPO
bundle install
To run the site locally, run:
bundle exec jekyll serve
Note that if you alter _config.yml, you will need to rerun the above command to see the changes reflected.
The easiest way to deploy your site is with GitHub Pages and the .github/workflows/jekyll.yml workflow included in this template.
See CONTRIBUTING.md for instructions on how to develop this template as part of your role on course staff or if you're otherwise interested in contributing to this template repository.