added the why to use some stuff and gitignore

This commit is contained in:
2025-01-27 19:11:51 +01:00
parent f3d04a368d
commit 54c2b78de6
4 changed files with 6 additions and 5 deletions

View File

@@ -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.