diff --git a/docs/assets/markdownViewerIcon.jpg b/docs/assets/markdownViewerIcon.jpg new file mode 100644 index 0000000..641b5d1 Binary files /dev/null and b/docs/assets/markdownViewerIcon.jpg differ 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