Skip to content

UCLOUVAIN-CLUB-ELEC/UCLOUVAIN-CLUB-ELEC.github.io

Repository files navigation

UCLOUVAIN-CLUB-ELEC.github.io

pre-commit.ci status

Contributing

Without installing anything

You can contribute to our website and see you changes without having to install anything! This can be done in a thwo-steps process:

  1. Fork this repository
  2. Follow the GitHub Pages setup

You should now be able to access your version of our website at https://<your_username>.github.io/UCLOUVAIN-CLUB-ELEC.github.io/. Any change that your will do to your fork (on the chosen branch) will directly reflect in changes your version of the website.

With local installation

To properly setup your local environment, please read this, but skip the jekyll new command. Then, you can read more about how this theme works here or learn with examples by directly looking at the code that generates this website.

Merging your changes onto our website

Once you are happy with your changes, create a Pull Request so that we can review, and hopefully accept your code.

GitHub Pages setup

In order to have your version of the website published on GitHub pages, please follow this:

  1. Modify the following entries in _config.yaml:
baseurl: "/UCLOUVAIN-CLUB-ELEC.github.io" # the subpath of your site, e.g. /blog
github_username: <your_username>
  1. Go to your fork (https://github.com/<your_username>/UCLOUVAIN-CLUB-ELEC.github.io/) and go to Settings -> Pages
  2. In Source, select a branch (usually main), and press Save

You will need to change a few things