From 57559e7275ba2da883d5e6873dcc31835acd51b5 Mon Sep 17 00:00:00 2001
From: Sam Hos <samhos2006@hotmail.com>
Date: Tue, 28 Jan 2025 10:38:08 +0100
Subject: [PATCH] markdown docs

---
 docs/assets/markdownViewerIcon.jpg | Bin 0 -> 637 bytes
 docs/week_1_fabacademy/markdown.md |  36 +++++++++++++++++++++++++++++
 2 files changed, 36 insertions(+)
 create mode 100644 docs/assets/markdownViewerIcon.jpg
 create mode 100644 docs/week_1_fabacademy/markdown.md

diff --git a/docs/assets/markdownViewerIcon.jpg b/docs/assets/markdownViewerIcon.jpg
new file mode 100644
index 0000000000000000000000000000000000000000..641b5d14232d44a8b4705057cf00ac6bd0c8172b
GIT binary patch
literal 637
zcmex=<NpH&0WUXCHwH#VCI(d?WcYuZ!I^=Lg_Vt!g^i7sjh&s1gG+#mi<6T}gpZ#`
zKwLyZLR>^lOiET&UP@Y7ModgWM?qOlT~kX_QeM|USHnP6LsJ7}2qQZ?I~NC+Fc+7w
zhLo6;2Fc+60R}-122BPTW=16jCP7AKLB{__7^E2(8JL)u8IS-QJ0mL-3kOhASAc<$
znT3&wnVl6X4`j12u(AmXDH;lkh_Wl0nL7q<PAn;H+z3=I!pMkZ444TNl@SD4fFi{x
zsF-;1gJa<TTMRtRK>G!m1sUuaJ}=eE?>Sd>y7A7tZBI6I{#$USUh<g0OWtYM7EKW2
zkae)XnzwP!sn5pJr&K-5r0%y%E|&<O&}X6Pw^ZeYvim~iwX$aWvYd9Dd$4+Cn4A8@
zJ4Nvkjn#%KN5xL+vvBxqbGp#G)X~#Hq51mWurJ@NS5&HOQ$KZj`lmB>>e|!fKeT24
zcC)wAUf!P~@Zgr}t#{ux7dHJqF+r$PwRP!{rU{jWVaKLaWo?^i6jQn5{ek|J>3Pi-
z3x#8S&Ko_N<+bypgQf?|1gp7Ueg&?syyO@Zac6c+)#2=IC$>i4+Zijd@7}{cJ@;I$
zzDx2fs@z=Pr*6E{n_a&&+~`I~q`!NyYp$;EYWL)X7ylWi8qI&J^kQj6*@+7Y#}egu
w^b9X-U$k{?q4ScWo3iKc%)82=GRf0geWyv;^9`aJZ)PmjbkOt)kpF)Z0Cr5t^8f$<

literal 0
HcmV?d00001

diff --git a/docs/week_1_fabacademy/markdown.md b/docs/week_1_fabacademy/markdown.md
new file mode 100644
index 0000000..1f0ee0c
--- /dev/null
+++ b/docs/week_1_fabacademy/markdown.md
@@ -0,0 +1,36 @@
+# Markdown
+
+## What is Markdown
+Markdown is a markup language. It's used a lot for documenting because its easy to style and you dont have to struggle with html css when used with Mkdocs or Hugo.
+
+## How do I use markdown
+Markdown can be used anywhere. You just simple have to create a file that ends with `.md`. If you wanna view the markdown that you're writing in vistual studio code you can click the icon below in the top right of your screen.
+
+![alt text](../assets/markdownViewerIcon.jpg)
+
+### Styling in markdown
+You can syle text by placing different operators around text.
+
+Basic markdown syntax
+
+
+| Text                                                | How to create it                                      |
+| --------------------------------------------------- | ----------------------------------------------------- |
+| *very italic*                                       | ```*a*```                                             |
+| **bold**                                            | ```**bold**```                                        |
+| # Head 1                                            | ```# Head1```                                         |
+| ## Head 2                                           | ```## Head 2 ```                                      |
+| ### Head 3                                          | ```### Head 3 ```                                     |
+| `code`                                              | suround text with `                                   |
+| [Link](https://www.youtube.com/watch?v=dQw4w9WgXcQ) | `[link](https://www.youtube.com/watch?v=dQw4w9WgXcQ)` |
+| ![image](relative_path_to_image)                    | `![image](relative_path_to_image_or_link)   `                   |
+|                                                     |                                                       |
+
+
+## Markdown conventions
+All markdown files must start with a `Head1` otherwise Mkdocs won't understand the file and the pipline will crash.
+
+
+
+## Sources 
+* [markdown cheatsheet](https://www.markdownguide.org/cheat-sheet/)
\ No newline at end of file