22-27th Sept 2021
1. State of the art, project management and documentation
I'm learning the language of Gitlab and Markdown and starting to format my website platform. I'll be documenting each process from this date for all my assignments - so this platform will be like a journal.
This first week introduces me to Markdown - a lightweight markup language, which can be converted into HMTL. Its main purpose is readability so it is quite user friendly and uses the file extension .md
My natural instinct with this presentation type of work is to create a personally stylised layout that I am comfortable editing in - self-representative. However, given my lack of familiarity with this format it has been a slow learning curve to realise the right formulas in terms of editing.
Every change has to be committed to.. a bit like in life?
always to the main branch
and should also be approved by the Pipeline 
.
(You can commit up to 10mb of changes at a time!)
(Pipeline basically records a history log of everything you edit.)
You can imagine my panic when a lot of my editing (mostly theme related) was failing:
...so to fix this I had to click directly on the commit number:
Mkdocs will give an indication of what the issue is which I'll go back to rectify. It's quite important to type codes with the right spacing, and map image links with the completed map and file type otherwise they won't appear properly, and the fails will pile up...
Formatting text¶
# Heading 1
## Heading 2
### Heading 3
This shows how¶
to create headings¶
in different sizes¶
(the size continues to resize smaller than the last the more headings and hashtags you use...)¶
"Quote" unquote
> Adding "quotes" is done quite simply with the larger-than-arrow
Bold and italics for emphasis always helps...
*italics* __bold__
Probably most importantly
<br />
break points are pretty crucial for spacing on the page.
Uploading media¶
So this is my attempt at uploading a gif. I think gifs are a cool way to show dynamic processes in a condensed way.
Choosing the font is like choosing the voice - so I'll try to select a fitting style.
Uploading pictures will be essential to show my processes: I can do this by uploading pictures/screenshots to the images folder:
and entering the image map code:
I watched this youtube video for a basic demonstration of some markdown:
To add a youtube video, you just click on share on the page and copy the embedded code into the body:
<iframe width="560" height="315" src="https://www.youtube.com/embed/HUBNt18RFbo" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
Also adding links is vital and really simple:
[the name of the link](https://thereallink.com)
<br />
- I
- added
- an unordered
- list like this:
- list point start
Customization¶
I changed the colour scheme by just changing the colours from markdown guide.
theme:
name: material
palette:
primary: teal
accent: pink
I had a look at some previous students' sites and like the personality and simplicity of their pages.
I decided I wanted to add some emojis to represent the personal journal style so this page has all the shortcuts.