README.md

Vivarium Collective Website

https://vivarium-collective.github.io

Setup

Install Dependencies

1. Install Ruby and Jekyll following Jekyll's documentation.

2. Install dependencies:

   $ bundle
   Fetching gem metadata from https://rubygems.org/..........
   Resolving dependencies...
   Using bundler 2.2.17

Usage

Compile Static HTML

bundle exec jekyll build

The static HTML will be placed in _site.

Serve Development Website

bundle exec jekyll serve

The website will be served at http://localhost:4000. Note that this command implicitly runs jekyll build.

Deploy to Production

Note that you shouldn't have to do this in normal usage. GitHub Actions has been configured to deploy the latest code in main every night at midnight and upon every push to main.

To deploy the compiled HTML to GitHub Pages, execute:

./deploy.sh

This will build the website and push the contents of _site to the gh-pages branch of the repository.