The website is build on GitHub using Jekyll, a simple, static site generator based on ruby. When you have a local copy cloned onto your computer, it is possible to generate the website based on this repo. This makes it possible to preview changes live, every time you save a file from within the GitHub infectious-diseases-toolkit repo. Follow these steps to deploy the website based on your local clone (copy) of the jekyll-bootstrap-theme repo:
Make sure you have cloned the infectious-diseases-toolkit repo:
git clone git@github.com:elixir-europe/infectious-diseases-toolkit.git
cd infectious-diseases-toolkit
To run the website locally, you can either use Docker or use Jekyll directly after installing various dependencies.
If not already installed on your machine, install Docker. From the root of the infectious-diseases-toolkit directory, run:
docker run -it --rm -p 4000:4000 -v $PWD:/srv/jekyll jekyll/jekyll:latest /bin/bash -c "chmod a+w /srv/jekyll/Gemfile.lock && chmod 777 /srv/jekyll && jekyll serve -w"
This will start the docker container and serve the website locally.
-
If not already present on your machine, install ruby. Note that incompatibility issues may arise with ruby 3.0.0 (released 25.12.20) or newer versions.
-
Install Jekyll If you have never installed or run a Jekyll site locally on your computer, follow these instructions to install Jekyll:
- Install Jekyll on MacOS/Ubuntu/Other_Linux/Windows: https://jekyllrb.com/docs/installation/
-
Install Bundler and Jekyll
gem install jekyll bundler -
Install dependencies
bundle install -
deploy website
bundle exec jekyll serve
Additional information can be found at the following link: https://docs.github.com/en/free-pro-team@latest/github/working-with-github-pages/testing-your-github-pages-site-locally-with-jekyll