This github page is set up with Jekyll. Jekyll is a static site generator with built-in support for GitHub Pages. The underlying theme is Minimal Mistakes.
The content of the website can be changed directly in GitHub in the repository. The content of the main page is in the file index.md . The elements of the footer are in _config.yml , the team members in _data/team.yml .
You need to have Jekyll installed, and Bundler is recommended. Follow Jekyll Installation Instruction to install Ruby and Jekyll with Homebrew. Then Bundler should be installed with Ruby by default. See also GitHub docu for Jekyll
To test the page go to the repository folder of this page in your terminal and run bundle exec jekyll serve . Follow the instructions in your terminal to open the site in your browser.
Changes will automatically be updated to the site, except of changes in _config.yml. If you want to see changes of the config file, you need to stop the execution of jekyll (control + c) and rerun bundle exec jekyll serve .
a. If you choose a Jekyll template supported by Github. Then in _config.yml, you need to comment out the line remote_theme: SOME_REMOTE_THEME_NAME and write instead theme: YOUR_CHOSEN_THEME_NAME . You also have to include gem: YOUR_CHOSEN_THEME_NAME in the Gemfile
OR
b. Choose a remot theme for example here. Then in _config.yml, you need to comment out the line theme: SOME_THEME_NAME and write instead remote_theme: YOUR_CHOSEN_REMOTE_THEME_NAME . You also have to comment out gem: SOME_THEME_NAME in the Gemfile .
Also add plugins in _config.yml and the Gemfile if required by the theme.
Use Bundler to update your Gemfile by running bundle install in the terminal.
The content of the config file _config.yml depends on the theme. In General there are site settings like title and url, build settings like the theme, side structure, and which files and folders should be included in the build process. There can also be additional informations for all pages like footer content.
You can choose to write your pages with markdown or html.
Every page starts with the document’s YAML Front Matter like:
---
layout: splash
title: "Surface AI"
header:
overlay_image: /assets/images/Stockimage.jpg
overlay_filter: rgba(100, 100, 100, 0.5)
caption: "Foto: Shutterstock"
excerpt: "Automatisierte Bestimmung"
---
layout defines the theme page layout. Minimal Mistakes Layouts. It can be set in the front matter or in _config.yml. The rest is optional.
A layout defines the structure and appearance of a page. It is therefore sufficient to write the content of a page in a simple Markdown or html file.
The main page is an index.md or index.html file.
Subpages need a permalink for their url path:
---
layout: splash
title: "Impressum"
permalink: /imprint/
---
Subpages are reached via baseurl + permalink.
To load dynamical content you can use a template in Liquid,
{% for member in site.data.team %}
{% include team.html member=member %}
{% endfor %}
implement the structure of the template in an html file in the _includes folder, and list the elements in a yaml file in the _data folder.
The Minimal Mistakes theme provides two footers. The structure of the Follow footer is implemented and the content is defined in the _config.yml file. A costum footer can be defined in costum.html in the folder _includes/footer
The Minimal Mistakes theme has a structure for a navigation bar implemented. The content has to be written in the _data/navigation.yml file:
main:
- title: "Home"
url: /surfaceai
- Line break without new paragraph: 2 spaces at the end of the line
Short markdown syntax overview in german