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.
Jekyll static site generator docs.
For more regarding the use of Jekyll, please refer to the Jekyll Step by Step Tutorial.
- Install a full Ruby development environment. If you use
rvm, run:rvm use 2.7.1. - Install bundler gems
gem install bundler
- Fork the project repository, then clone your fork.
- Change into the project directory:
cd gefyrahq.github.io
- Use bundler to fetch all required gems in their respective versions
bundle install
- 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
- Now browse to http://127.0.0.1:4000
The main branch gets automatically deployed to GitHub Pages.
This website is not yet licenced.