1 minute read

If you’re new to Github you might find it useful to first checkout first-contributions to learn more about forks, branches and pull requests.

  • Fork the energy-modelling-ireland.github.io repository to create your own copy (or origin) of the website that you can edit to your heart’s content.


  • If you have already forked the website and your forked repository is out of date (i.e. This branch is x commits behind energy-modelling-ireland/energy-modelling-ireland.github.io:gh-pages), please sync it by following the gif below. See Sync a GitHub Repo: How To Ensure Your GitHub Fork Is Up To Date



  • Make your changes directly on Github (see docs):

    • Go to your forked repository

    • Create a new branch and name it after what you’re trying to achieve (i.e. add-github-contribution-guide)


    • To add a new post click into _posts, click Create new file and name it YEAR-MONTH-DAY-title.md. See Jekyll.



    • To upload images click into /assets/images/, click Create new file, give it same name as your post (i.e. YEAR-MONTH-DAY-title/), click into it and click Upload files. To link your post to the uploaded images copy & paste the snippet below into your post and adapt the filepath for your image. See existing _posts/.

      ![My helpful screenshot](/assets/YEAR-MONTH-DAY-title/screenshot.jpg)
    • To preview your changes try them out by publishing them on Github Pages. Click on the Settings tab, scroll down on the settings page, click on the Pages section, select your branch, click Save, wait a few minutes and click on the link suggested by Your site is ready to be published at https://USERNAME.github.io/energy-modelling-ireland.github.io/ to view. See Github.



  • Or make your changes locally:

    • Go to your fork’s Github page and clone your fork

    • Create a new branch and name it after what you’re trying to achieve (i.e. add-github-contribution-guide)

    • Follow the instructions here (or if you know docker here)

    • Make your changes locally and use git (first-contributions) to commit them locally and when ready to push the changes to your forked repository.

  • Submit a pull request with your changes so they can be approved and deployed to the main website (or upstream).