1. Principles and practices¶
This weeks goal was to build a website, wich describes me and my final project.
My Setup¶
Greenshot - Screenshots and editing¶
HandBrake - Video editing¶
Notepad ++ - Documentation in Markdown¶
Git GUI - Graphical Interface for GIT Commands¶
Using GIT¶
Git is a version control system, published in 2005 and in this case used for setting up the website.
Learn more about GIT at Atlassian.
Some videos that helped me a lot:
50min - Getting out of Trouble by Understanding Git - Steve Smith - GOTO 2019
20min - GIT Tutorial For Dummies
4min - How GIT works: explained in 4 minutes
For authentication and signing I first had to generate an SSH Key and link it to GitGUI.
With this setup I have access to my GitLab repository and I am able to launch my website. For this I had to clone the template repository and switch it to MKDocs.
I use MKDocs because it’s way easier for me to build and write in Markdown rather than HTML.
After setting up GitGUI options I can start the real work with my website.
To launch some changes I have to syncronise my repository with the GITLab repository.
This is the GitGUI menu.
After changing some files it will be shown as here.
The next step is to stage the changes.
The commit message describes my changes.
To upload the repository I have to push it.
Once the upload is finished the success notification shows up.
Setup of the website¶
To write and build the website I had to get used to markdown text formatting.
Markdown Guide
The menu bar and table of contents use the headings syntax. It can be defined with #,##,### or #### and the following text.
#This is an H1 heading
Pictures are implemented with an alternative text (shown when the picture can’t load) and the storage location.
Bold or italic text is implemented as follows.
**bold** or *italic*
This is the syntax for clickable links.
[Text](URL)
And a seperator line can be added like this.
<hr />
A big thank you to my instructor Lars Mattern, without whose help this week would have been hell for me!