diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..600d2d3 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.vscode \ No newline at end of file diff --git a/docs/bootcamp/mkdocs.md b/docs/bootcamp/mkdocs.md index ca0ded7..8364578 100644 --- a/docs/bootcamp/mkdocs.md +++ b/docs/bootcamp/mkdocs.md @@ -1,7 +1,7 @@ # How to set up your own documentation page using mkdocs -## What is Mkdocs -Mkdocs generate html from markdown making an easy documentation page. +## What is Mkdocs and why use it? +Mkdocs generates HTML from Markdown making an easy documentation page. So you don't have to struggle with html and css. ## How to set it up For this project im going to use Gitlab CI pipelines. CI stands for continuous intergration. That means that with every push you can make something do for example clean up code or generate a documentation page based on what you've written in markdown. diff --git a/docs/bootcamp/ssh_config.md b/docs/bootcamp/ssh_config.md index 12cb2f1..aa3e291 100644 --- a/docs/bootcamp/ssh_config.md +++ b/docs/bootcamp/ssh_config.md @@ -1,7 +1,7 @@ # SSH config files -## brief -This is the first time for me using ssh config files so that's why this is a seperate file. +## Why use ssh config files? +SSH config files are nice to have when you need to connect to multiple servers and don't wanna type the entire an entire serveradress and username. ## What can you do with ssh config files In SSH config files you can describe how connections should be handled and with which keys you want to use to log in onto a specific server and much more. diff --git a/docs/week_1_fabacademy/customising-mkdocs.md b/docs/week_1_fabacademy/customising_mkdocs.md similarity index 92% rename from docs/week_1_fabacademy/customising-mkdocs.md rename to docs/week_1_fabacademy/customising_mkdocs.md index 3ff5fba..6ab1c95 100644 --- a/docs/week_1_fabacademy/customising-mkdocs.md +++ b/docs/week_1_fabacademy/customising_mkdocs.md @@ -1,6 +1,6 @@ # Customising mkdocs -I wanna customise my mkdocs theme. So I can have a dark mode. Because it currently looks like this. +I wanna customise my mkdocs theme. So I can have a dark mode. Because it currently looks like this and having a nice looking documentation page is necessary too! ![alt text](../assets/customising_mkdocs.jpg)