CDSS Common Documentation

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:

• You have everything that Jekyll requires
• You have installed Bundler: Run gem install jekyll bundler

Clone the repository and install dependencies

git clone [email protected]:berkeley-cdss/docs.git
bundle install

Usage

To run the site locally, run:

cd <PATH_TO_CLONED_REPO>
bundle exec jekyll serve

Note that if you alter _config.yml, you will need to rerun the above command to see the changes reflected.

Deployment

Via GitHub Pages.

Contributing

See CONTRIBUTING.md

License

MIT