diff --git a/docs/2022/09/20/how-to-create-githubpage.html b/docs/2022/09/20/how-to-create-githubpage.html index 0747786..07da800 100644 --- a/docs/2022/09/20/how-to-create-githubpage.html +++ b/docs/2022/09/20/how-to-create-githubpage.html @@ -20,153 +20,91 @@

Install Git


-
- -

Install Ruby


-
- -

Install Jekyll and Bundler
$ gem install jekyll bundler

-
- -

- Create a GitHub-account
- Create a repository on GitHub
+ Create a GitHub-account
+ Create a repository on GitHub
(It has to be public if you use GitHub Free, note that your code will be visible to everyone!)

-
- -

Clone the repository to a local directory:
- SSH
-

- $ git clone --recursive SSH_URL
-
- HTTPS
-
- $ git -c http.sslVerify=false clone --recursive HTTPS_URL
-
+ SSH
+ $ git clone --recursive SSH_URL
+ HTTPS
+ $ git -c http.sslVerify=false clone --recursive HTTPS_URL

-
- -

Create two directories: docs and localDev.

- 
-                $ mkdir docs

-                

-                $ mkdir localDev

-
+ $ mkdir docs
+ $ mkdir localDev
docs will contain the content of the website later on.
localDev will contain our Jekyll project.

-
- -

Move to the localDev-directory:

- 
-                $ cd localDev

-
+ $ cd localDev

-
- -

Create a new Jekyll-project at localDev-directory:

- 
-                $ jekyll new --skip-bundle .

-                

-                (make sure you got the dot)

-
+ $ jekyll new --skip-bundle .
+ (make sure you got the dot)

-
- -

- Open the Gemfile that Jekyll created and comment out the line which starts with gem "jekyll"
+ Open the Gemfile that Jekyll created and comment out the line which starts with gem "jekyll"
Add the github-pages gem by editing the line starting with # gem "github-pages".
Change this line (# gem "github-pages") to:
- gem "github-pages", "~> GITHUB-PAGES-VERSION", group: :jekyll_plugins
+ gem "github-pages", "~> GITHUB-PAGES-VERSION", group: :jekyll_plugins
You can find the actual version of GitHub-pages here
. Now save and close the Gemfile.

-
- -

Now still being at the localDev-directory, install the bundle:

- 
-                $ bundle install

-
+ $ bundle install
- Optionally you can make changes at the _config.yml file.
+ Optionally you can make changes at the _config.yml file.

-
- -

Follow this guide to learn Jekyll. Make sure that all files and directories you create are in the localDev-directory.
Note that building locally will not work according to commenting out gem "Jekyll" at the Gemfile. (Atm I didn't check if you can let it in and bundle install to allow local building)

-
- -

After creating all necessary files and dirs, you can make a production build:
Note that all files at _site will be cleared!

- 
-                $ JEKYLL_ENV=production bundle exec jekyll build

-
+ $ JEKYLL_ENV=production bundle exec jekyll build
Your Jekyll-project was now build and stored at _site.
Now move the content of the localDev/_site to docs:
- 
-                $ mv /localDev/_site docs

-
-
- And push your changes to your central GitHub-Repository:
-
- 
-
-
+ $ mv /localDev/_site docs
+ And push your changes to your central GitHub-Repository.

-
- -

Now publish your repository on GitHub Pages.
- Select your branch and as folder /docs and hit Save.
+ Select your branch and as folder /docs and hit Save.
Now you have to wait, this can take up to 10 minutes.
On the top of the page a box will appear with the url of your website.

Happy developing!

-
- -
-

+

Sources:

- - - - 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