Gefyra.dev Website Based on Jekyll

These instructions will get you a copy of the Gefyra.dev website up and running on your local machine for development and testing purposes. This website uses GitHub Pages special remote_theme which is not locally installed.

Installation

Jekyll static site generator docs.
For more regarding the use of Jekyll, please refer to the Jekyll Step by Step Tutorial.

1. Install a full Ruby development environment. If you use rvm, run: rvm use 2.7.1.
2. Install bundler gems

gem install bundler

3. Fork the project repository, then clone your fork.
4. Change into the project directory:

cd gefyrahq.github.io

5. Use bundler to fetch all required gems in their respective versions

bundle install

6. Build the site and make it available on a local server

In _config.yml comment in the theme key which is required for local development. Important: Please be sure to comment it out before you push or PR to main, otherwise GitHub Pages will not be able to deploy.

theme: "just-the-docs"

# this is used by GitHub
remote_theme: "just-the-docs/just-the-docs"

then

bundle exec jekyll serve

7. Now browse to http://127.0.0.1:4000

Deploying to GitHub Pages

The main branch gets automatically deployed to GitHub Pages.

License

This website is not yet licenced.