---
layout: post
author: Aaron
title: How to create a static website with Jekyll and deploy it on GitHubPages
---

<section>
    <p>Install <a href="https://git-scm.com/downloads" target="_blank">Git</a></p><br>
</section>

<section>
    <p>Install <a href="https://www.ruby-lang.org/en/documentation/installation/" target="_blank">Ruby</a></p><br>
</section>

<section>
    <p>
        Install Jekyll and Bundler<br>
        <code>$ gem install jekyll bundler</code><br>
    </p>
</section>

<section>
    <p>
        <a href="https://github.com/" target="_blank">Create a GitHub-account</a><br>
        <a href="https://github.com/new" target="_blank">Create a repository on GitHub</a><br>
        (It has to be public if you use GitHub Free, note that your code will be visible to everyone!)<br>
    </p>
</section>

<section>
    <p>
        Clone the repository to a local directory:<br>
        <b>SSH</b><br>
        <div>
            $ git clone --recursive SSH_URL<br>
        </div>
        <b>HTTPS</b><br>
        <div>
            $ git -c http.sslVerify=false clone --recursive HTTPS_URL<br>
        </div>
    </p>
</section>

<section>
    <p>
        Create two directories: docs and localDev.<br>
        <div>
            <pre>
                $ mkdir docs<br>
                <br>
                $ mkdir localDev<br>
            </pre>
        </div>
        docs will contain the content of the website later on.<br>
        localDev will contain our Jekyll project.<br>
    </p>
</section>

<section>
    <p>
        Move to the localDev-directory:<br>
        <div>
            <pre>
                $ cd localDev<br>
            </pre>
        </div>
    </p>
</section>

<section>
    <p>
        Create a new Jekyll-project at localDev-directory:<br>
        <div>
            <pre>
                $ jekyll new --skip-bundle .<br>
                <br>
                (make sure you got the dot)<br>
            </pre>
        </div>
    </p>
</section>

<section>
    <p>
        Open the Gemfile that Jekyll created and comment out the line which starts with <b>gem "jekyll"</b><br>
        Add the github-pages gem by editing the line starting with # gem "github-pages".<br>
        Change this line (# gem "github-pages") to:<br>
        <b>gem "github-pages", "~> GITHUB-PAGES-VERSION", group: :jekyll_plugins</b><br>
        You can find the actual version of GitHub-pages <a href="https://rubygems.org/gems/github-pages" target="_blank">here</a><br>.
        Now save and close the Gemfile.<br>
    </p>
</section>

<section>
    <p>
        Now still being at the localDev-directory, install the bundle:<br>
        <div>
            <pre>
                $ bundle install<br>
            </pre>
        </div>
        Optionally you can make changes at the <b>_config.yml</b> file.
    </p>
</section>

<section>
    <p>
        Optionally you can create <b>another branch</b> called gh-pages from where GitHub Pages will take the website-files.<br>
        <div>
            <pre>
                $ git checkout -b gh-pages<br>
            </pre>
        </div>
    </p>
</section>

<section>
    Follow instructions on: https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll<br>
    Deploy: https://jekyllrb.com/docs/step-by-step/10-deployment/<br>
    JEKYLL_ENV=production bundle exec jekyll build
    https://jekyllrb.com/docs/step-by-step/01-setup/
    https://jekyllrb.com/docs/structure/
    https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/testing-your-github-pages-site-locally-with-jekyll
    https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll
    https://docs.github.com/en/get-started/quickstart/set-up-git
    https://docs.github.com/en/pages/quickstart
    https://github.com/WickedJack99/website/settings/pages
    https://wickedjack99.github.io/website/2022/09/20/jekyll_&_github.html
    https://nav.hs-offenburg.de/pflichtnavi/erklaerung-zur-barrierefreiheit
    https://duckduckgo.com/?q=german+english&t=newext&atb=v330-1&ia=web
    https://www.markdownguide.org/basic-syntax
    https://www.w3schools.com/html/default.asp
    https://www.w3schools.com/html/tryit.asp?filename=tryhtml_figcaption
    https://www.w3schools.com/html/tryit.asp?filename=tryhtml5_section
</section>