pushing localDocs to main-branch

This commit is contained in:
WickedJack99
2022-09-21 11:01:08 +02:00
parent 9fe6bb9e07
commit 1cfa6349b3
24 changed files with 666 additions and 0 deletions

5
localdocs/.gitignore vendored Normal file
View File

@@ -0,0 +1,5 @@
_site
.sass-cache
.jekyll-cache
.jekyll-metadata
vendor

25
localdocs/404.html Normal file
View File

@@ -0,0 +1,25 @@
---
permalink: /404.html
layout: default
---
<style type="text/css" media="screen">
.container {
margin: 10px auto;
max-width: 600px;
text-align: center;
}
h1 {
margin: 30px 0;
font-size: 4em;
line-height: 1;
letter-spacing: -1px;
}
</style>
<div class="container">
<h1>404</h1>
<p><strong>Page not found :(</strong></p>
<p>The requested page could not be found.</p>
</div>

33
localdocs/Gemfile Normal file
View File

@@ -0,0 +1,33 @@
source "https://rubygems.org"
# Hello! This is where you manage which Jekyll version is used to run.
# When you want to use a different version, change it below, save the
# file and run `bundle install`. Run Jekyll with `bundle exec`, like so:
#
# bundle exec jekyll serve
#
# This will help ensure the proper Jekyll version is running.
# Happy Jekylling!
# gem "jekyll", "~> 4.2.2"
# This is the default theme for new Jekyll sites. You may change this to anything you like.
gem "minima", "~> 2.5"
# If you want to use GitHub Pages, remove the "gem "jekyll"" above and
# uncomment the line below. To upgrade, run `bundle update github-pages`.
gem "github-pages", "~> 227", group: :jekyll_plugins
# If you have any plugins, put them here!
group :jekyll_plugins do
gem "jekyll-feed", "~> 0.12"
end
# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem
# and associated library.
platforms :mingw, :x64_mingw, :mswin, :jruby do
gem "tzinfo", "~> 1.2"
gem "tzinfo-data"
end
# Performance-booster for watching directories on Windows
gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin]
# Lock `http_parser.rb` gem to `v0.6.x` on JRuby builds since newer versions of the gem
# do not have a Java counterpart.
gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]

267
localdocs/Gemfile.lock Normal file
View File

@@ -0,0 +1,267 @@
GEM
remote: https://rubygems.org/
specs:
activesupport (6.0.6)
concurrent-ruby (~> 1.0, >= 1.0.2)
i18n (>= 0.7, < 2)
minitest (~> 5.1)
tzinfo (~> 1.1)
zeitwerk (~> 2.2, >= 2.2.2)
addressable (2.8.1)
public_suffix (>= 2.0.2, < 6.0)
coffee-script (2.4.1)
coffee-script-source
execjs
coffee-script-source (1.11.1)
colorator (1.1.0)
commonmarker (0.23.5)
concurrent-ruby (1.1.10)
dnsruby (1.61.9)
simpleidn (~> 0.1)
em-websocket (0.5.3)
eventmachine (>= 0.12.9)
http_parser.rb (~> 0)
ethon (0.15.0)
ffi (>= 1.15.0)
eventmachine (1.2.7)
execjs (2.8.1)
faraday (2.5.2)
faraday-net_http (>= 2.0, < 3.1)
ruby2_keywords (>= 0.0.4)
faraday-net_http (3.0.0)
ffi (1.15.5)
forwardable-extended (2.6.0)
gemoji (3.0.1)
github-pages (227)
github-pages-health-check (= 1.17.9)
jekyll (= 3.9.2)
jekyll-avatar (= 0.7.0)
jekyll-coffeescript (= 1.1.1)
jekyll-commonmark-ghpages (= 0.2.0)
jekyll-default-layout (= 0.1.4)
jekyll-feed (= 0.15.1)
jekyll-gist (= 1.5.0)
jekyll-github-metadata (= 2.13.0)
jekyll-include-cache (= 0.2.1)
jekyll-mentions (= 1.6.0)
jekyll-optional-front-matter (= 0.3.2)
jekyll-paginate (= 1.1.0)
jekyll-readme-index (= 0.3.0)
jekyll-redirect-from (= 0.16.0)
jekyll-relative-links (= 0.6.1)
jekyll-remote-theme (= 0.4.3)
jekyll-sass-converter (= 1.5.2)
jekyll-seo-tag (= 2.8.0)
jekyll-sitemap (= 1.4.0)
jekyll-swiss (= 1.0.0)
jekyll-theme-architect (= 0.2.0)
jekyll-theme-cayman (= 0.2.0)
jekyll-theme-dinky (= 0.2.0)
jekyll-theme-hacker (= 0.2.0)
jekyll-theme-leap-day (= 0.2.0)
jekyll-theme-merlot (= 0.2.0)
jekyll-theme-midnight (= 0.2.0)
jekyll-theme-minimal (= 0.2.0)
jekyll-theme-modernist (= 0.2.0)
jekyll-theme-primer (= 0.6.0)
jekyll-theme-slate (= 0.2.0)
jekyll-theme-tactile (= 0.2.0)
jekyll-theme-time-machine (= 0.2.0)
jekyll-titles-from-headings (= 0.5.3)
jemoji (= 0.12.0)
kramdown (= 2.3.2)
kramdown-parser-gfm (= 1.1.0)
liquid (= 4.0.3)
mercenary (~> 0.3)
minima (= 2.5.1)
nokogiri (>= 1.13.6, < 2.0)
rouge (= 3.26.0)
terminal-table (~> 1.4)
github-pages-health-check (1.17.9)
addressable (~> 2.3)
dnsruby (~> 1.60)
octokit (~> 4.0)
public_suffix (>= 3.0, < 5.0)
typhoeus (~> 1.3)
html-pipeline (2.14.2)
activesupport (>= 2)
nokogiri (>= 1.4)
http_parser.rb (0.8.0)
i18n (0.9.5)
concurrent-ruby (~> 1.0)
jekyll (3.9.2)
addressable (~> 2.4)
colorator (~> 1.0)
em-websocket (~> 0.5)
i18n (~> 0.7)
jekyll-sass-converter (~> 1.0)
jekyll-watch (~> 2.0)
kramdown (>= 1.17, < 3)
liquid (~> 4.0)
mercenary (~> 0.3.3)
pathutil (~> 0.9)
rouge (>= 1.7, < 4)
safe_yaml (~> 1.0)
jekyll-avatar (0.7.0)
jekyll (>= 3.0, < 5.0)
jekyll-coffeescript (1.1.1)
coffee-script (~> 2.2)
coffee-script-source (~> 1.11.1)
jekyll-commonmark (1.4.0)
commonmarker (~> 0.22)
jekyll-commonmark-ghpages (0.2.0)
commonmarker (~> 0.23.4)
jekyll (~> 3.9.0)
jekyll-commonmark (~> 1.4.0)
rouge (>= 2.0, < 4.0)
jekyll-default-layout (0.1.4)
jekyll (~> 3.0)
jekyll-feed (0.15.1)
jekyll (>= 3.7, < 5.0)
jekyll-gist (1.5.0)
octokit (~> 4.2)
jekyll-github-metadata (2.13.0)
jekyll (>= 3.4, < 5.0)
octokit (~> 4.0, != 4.4.0)
jekyll-include-cache (0.2.1)
jekyll (>= 3.7, < 5.0)
jekyll-mentions (1.6.0)
html-pipeline (~> 2.3)
jekyll (>= 3.7, < 5.0)
jekyll-optional-front-matter (0.3.2)
jekyll (>= 3.0, < 5.0)
jekyll-paginate (1.1.0)
jekyll-readme-index (0.3.0)
jekyll (>= 3.0, < 5.0)
jekyll-redirect-from (0.16.0)
jekyll (>= 3.3, < 5.0)
jekyll-relative-links (0.6.1)
jekyll (>= 3.3, < 5.0)
jekyll-remote-theme (0.4.3)
addressable (~> 2.0)
jekyll (>= 3.5, < 5.0)
jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0)
rubyzip (>= 1.3.0, < 3.0)
jekyll-sass-converter (1.5.2)
sass (~> 3.4)
jekyll-seo-tag (2.8.0)
jekyll (>= 3.8, < 5.0)
jekyll-sitemap (1.4.0)
jekyll (>= 3.7, < 5.0)
jekyll-swiss (1.0.0)
jekyll-theme-architect (0.2.0)
jekyll (> 3.5, < 5.0)
jekyll-seo-tag (~> 2.0)
jekyll-theme-cayman (0.2.0)
jekyll (> 3.5, < 5.0)
jekyll-seo-tag (~> 2.0)
jekyll-theme-dinky (0.2.0)
jekyll (> 3.5, < 5.0)
jekyll-seo-tag (~> 2.0)
jekyll-theme-hacker (0.2.0)
jekyll (> 3.5, < 5.0)
jekyll-seo-tag (~> 2.0)
jekyll-theme-leap-day (0.2.0)
jekyll (> 3.5, < 5.0)
jekyll-seo-tag (~> 2.0)
jekyll-theme-merlot (0.2.0)
jekyll (> 3.5, < 5.0)
jekyll-seo-tag (~> 2.0)
jekyll-theme-midnight (0.2.0)
jekyll (> 3.5, < 5.0)
jekyll-seo-tag (~> 2.0)
jekyll-theme-minimal (0.2.0)
jekyll (> 3.5, < 5.0)
jekyll-seo-tag (~> 2.0)
jekyll-theme-modernist (0.2.0)
jekyll (> 3.5, < 5.0)
jekyll-seo-tag (~> 2.0)
jekyll-theme-primer (0.6.0)
jekyll (> 3.5, < 5.0)
jekyll-github-metadata (~> 2.9)
jekyll-seo-tag (~> 2.0)
jekyll-theme-slate (0.2.0)
jekyll (> 3.5, < 5.0)
jekyll-seo-tag (~> 2.0)
jekyll-theme-tactile (0.2.0)
jekyll (> 3.5, < 5.0)
jekyll-seo-tag (~> 2.0)
jekyll-theme-time-machine (0.2.0)
jekyll (> 3.5, < 5.0)
jekyll-seo-tag (~> 2.0)
jekyll-titles-from-headings (0.5.3)
jekyll (>= 3.3, < 5.0)
jekyll-watch (2.2.1)
listen (~> 3.0)
jemoji (0.12.0)
gemoji (~> 3.0)
html-pipeline (~> 2.2)
jekyll (>= 3.0, < 5.0)
kramdown (2.3.2)
rexml
kramdown-parser-gfm (1.1.0)
kramdown (~> 2.0)
liquid (4.0.3)
listen (3.7.1)
rb-fsevent (~> 0.10, >= 0.10.3)
rb-inotify (~> 0.9, >= 0.9.10)
mercenary (0.3.6)
minima (2.5.1)
jekyll (>= 3.5, < 5.0)
jekyll-feed (~> 0.9)
jekyll-seo-tag (~> 2.1)
minitest (5.16.3)
nokogiri (1.13.8-x86_64-linux)
racc (~> 1.4)
octokit (4.25.1)
faraday (>= 1, < 3)
sawyer (~> 0.9)
pathutil (0.16.2)
forwardable-extended (~> 2.6)
public_suffix (4.0.7)
racc (1.6.0)
rb-fsevent (0.11.2)
rb-inotify (0.10.1)
ffi (~> 1.0)
rexml (3.2.5)
rouge (3.26.0)
ruby2_keywords (0.0.5)
rubyzip (2.3.2)
safe_yaml (1.0.5)
sass (3.7.4)
sass-listen (~> 4.0.0)
sass-listen (4.0.0)
rb-fsevent (~> 0.9, >= 0.9.4)
rb-inotify (~> 0.9, >= 0.9.7)
sawyer (0.9.2)
addressable (>= 2.3.5)
faraday (>= 0.17.3, < 3)
simpleidn (0.2.1)
unf (~> 0.1.4)
terminal-table (1.8.0)
unicode-display_width (~> 1.1, >= 1.1.1)
thread_safe (0.3.6)
typhoeus (1.4.0)
ethon (>= 0.9.0)
tzinfo (1.2.10)
thread_safe (~> 0.1)
unf (0.1.4)
unf_ext
unf_ext (0.0.8.2)
unicode-display_width (1.8.0)
zeitwerk (2.6.0)
PLATFORMS
x86_64-linux
DEPENDENCIES
github-pages (~> 227)
http_parser.rb (~> 0.6.0)
jekyll-feed (~> 0.12)
minima (~> 2.5)
tzinfo (~> 1.2)
tzinfo-data
wdm (~> 0.1.1)
BUNDLED WITH
2.3.22

15
localdocs/README.md Normal file
View File

@@ -0,0 +1,15 @@
This is my first approach to a website which is deployed to GitHub Pages.
I use Jekyll for some nice building tricks.
> https://jekyllrb.com/
Things for me to check out:
> https://jekyllrb.com/docs/liquid/tags/
>
> https://jekyllrb.com/docs/variables/
Visit Page: (Will make a guide how I did the setup of the webpage)
https://wickedjack99.github.io/website/

54
localdocs/_config.yml Normal file
View File

@@ -0,0 +1,54 @@
# Welcome to Jekyll!
#
# This config file is meant for settings that affect your whole blog, values
# which you are expected to set up once and rarely edit after that. If you find
# yourself editing this file very often, consider using Jekyll's data files
# feature for the data you need to update frequently.
#
# For technical reasons, this file is *NOT* reloaded automatically when you use
# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
#
# If you need help with YAML syntax, here are some quick references for you:
# https://learn-the-web.algonquindesign.ca/topics/markdown-yaml-cheat-sheet/#yaml
# https://learnxinyminutes.com/docs/yaml/
#
# Site settings
# These are used to personalize your new site. If you look in the HTML files,
# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
# You can create any custom variable you would like, and they will be accessible
# in the templates via {{ site.myvariable }}.
title: Mr.
email: amoser@stud.hs-offenburg.de
description: >- # this means to ignore newlines until "baseurl:"
Write an awesome description for your new site here. You can edit this
line in _config.yml. It will appear in your document head meta (for
Google search results) and in your feed.xml site description.
baseurl: "" # the subpath of your site, e.g. /blog
url: "" # the base hostname & protocol for your site, e.g. http://example.com
github_username: WickedJack99
# Build settings
theme: minima
plugins:
- jekyll-feed
# Exclude from processing.
# The following items will not be processed, by default.
# Any item listed under the `exclude:` key here will be automatically added to
# the internal "default list".
#
# Excluded items can be processed by explicitly listing the directories or
# their entries' file path in the `include:` list.
#
# exclude:
# - .sass-cache/
# - .jekyll-cache/
# - gemfiles/
# - Gemfile
# - Gemfile.lock
# - node_modules/
# - vendor/bundle/
# - vendor/cache/
# - vendor/gems/
# - vendor/ruby/

View File

@@ -0,0 +1,8 @@
- name: Terms
link: /website/terms.html
- name: Privacy
link: /website/privacy.html
- name: Blog
link: /website/blog.html
- name: Imprint
link: /website/imprint.html

View File

@@ -0,0 +1,6 @@
- name: Home
link: /website/index.html
- name: About
link: /website/about.html
- name: Blog
link: /website/blog.html

View File

@@ -0,0 +1,5 @@
<nav>
{% for item in site.data.footerNavbar %}
<a href="{{ item.link }}" {% if page.url == item.link %} class="current" {% endif %}>{{ item.name }}</a>
{% endfor %}
</nav>

View File

@@ -0,0 +1,5 @@
<nav>
{% for item in site.data.navigation %}
<a href="{{ item.link }}" {% if page.url == item.link %} class="current" {% endif %}>{{ item.name }}</a>
{% endfor %}
</nav>

View File

@@ -0,0 +1,13 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>{{ page.title }}</title>
<link rel="stylesheet" href="/assets/css/styles.css">
</head>
<body>
{% include navigation.html %}
{{ content }}
{% include footerNavbar.html %}
</body>
</html>

View File

@@ -0,0 +1,13 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>{{ page.title }}</title>
<link rel="stylesheet" href="/assets/css/law.css">
</head>
<body>
{% include navigation.html %}
{{ content }}
{% include footerNavbar.html %}
</body>
</html>

View File

@@ -0,0 +1,7 @@
---
layout: default
---
<h1>{{ page.title }}</h1>
<p>{{ page.date | date_to_string }} - {{ page.author }}</p>
{{ content }}

View File

@@ -0,0 +1,135 @@
---
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>

View File

@@ -0,0 +1,3 @@
.current {
color: black;
}

9
localdocs/about.html Normal file
View File

@@ -0,0 +1,9 @@
---
layout: default
title: About
---
<h1>About</h1>
<p>What's uuuuuuuuuuuuuuuuuuuuuuuup!</p>
<p>My name is Aaron and I'm studying Applied Computer Science at the University of Applied Science Offenburg.</p>
<p>This is my first approach of a website using Jekyll.</p>

View File

@@ -0,0 +1,5 @@
---
layout: law
title: Accessibility
---
<h1>{{ page.title }}</h1>

View File

@@ -0,0 +1,3 @@
---
---
@import "main";

View File

@@ -0,0 +1,3 @@
---
---
@import "main";

13
localdocs/blog.html Normal file
View File

@@ -0,0 +1,13 @@
---
layout: default
title: Blog
---
<h1>Latest Posts</h1>
<ul>
{% for post in site.posts %}
<li>
<h3><a href="{{ '/website' | append: post.url }}">{{ post.title }}</a></h3>
</li>
{% endfor %}
</ul>

11
localdocs/imprint.html Normal file
View File

@@ -0,0 +1,11 @@
---
layout: law
title: Blog
---
<h1>Imprint</h1>
<p id="imprintContact">
Aaron Moser<br>
Zaehringerstrasse 36b<br>
77652 Offenburg<br>
E-Mail: amoser@stud.hs-offenburg.de<br>
</p>

6
localdocs/index.html Normal file
View File

@@ -0,0 +1,6 @@
---
layout: default
title: Homepage
---
<h1>{{ page.title }}</h1>

15
localdocs/privacy.html Normal file
View File

@@ -0,0 +1,15 @@
---
layout: law
title: Privacy
---
<h1>Privacy Policy</h1>
<h3>Links to external websites</h3>
<p> This website contains links to external websites. I have no access on the content of these websites
and take no responsibilities or liablities for the admissibility, correctness, presentation and completeness
of that content.</p>
<p> I'm informing you that with following those links, probably your IP-address will be recorded.</p>
<p> If you leave this website I recommend you to check out their Privacy-Policy before accessing their website.</p>
<h3>Cookies :P</h3>
<p>I'm hungry, give me some cookies please!</p>
<p>I don't use cookies but this site is hosted by GitHub Pages so maybe they use them.</p>

7
localdocs/terms.html Normal file
View File

@@ -0,0 +1,7 @@
---
layout: law
title: Terms & Conditions
---
<h1>Terms and Conditions</h1>
<p></p>
<p></p>