Website for the CanDIG project; based on the Agency Jekyll Theme.
This is a Jekyll website. To develop on your own machine, first follow the Jekyll install instructions for your system: that will look a little like
gem install bundler jekyll
once you have a new Ruby and ruby gems installed, but the details will differ a bit between platforms.
You will also need a Javascript runtime installed, one way that works is to install node.js.
Once you're done, from the candig.github.io
directory run
bundle install
bundle exec jekyll serve
If you are using ruby 3.0, you will also need to install webrick
bundle add webrick
And, absent any errors you'll be able to view the website at http://localhost:4000
.
As you edit files, jekyll will re-build periodicially for frequent updates. The generated
pages are in the _site
directory if you want to directly view the outputs.
Commits will trigger a Cloudflare Pages build after a few minutes; PRs will be updated with links ot previews. For changes and updates, make a PR and request a review so everyone can benefit from the preview.
Note for building locally: for Historical Reasons (tm), people still point to candig.github.io, and we want
them to be redirected to the real URL. By default Jekyll builds with the Jekyll environment
variable set to development
; the GitHub pages deployment builds with the variable set to
production
. So if environment is not development
, a meta refresh tag is included in the
header (_includes/head.html
) to refresh to distributedgenomics.ca (properly, {{ site.url }}
;
otherwise it doesn't. You can test this behaviour by setting the environment variable explicitly:
JEKYLL_ENV=production bundle exec jekyll serve