mirror of
https://gitlab.waag.org/make/fablab/interns/2025/sam.git
synced 2025-08-03 11:54:58 +00:00
added the why to use some stuff and gitignore
This commit is contained in:
1
.gitignore
vendored
Normal file
1
.gitignore
vendored
Normal file
@@ -0,0 +1 @@
|
|||||||
|
.vscode
|
@@ -1,7 +1,7 @@
|
|||||||
# How to set up your own documentation page using mkdocs
|
# How to set up your own documentation page using mkdocs
|
||||||
|
|
||||||
## What is Mkdocs
|
## What is Mkdocs and why use it?
|
||||||
Mkdocs generate html from markdown making an easy documentation page.
|
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
|
## 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.
|
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.
|
||||||
|
@@ -1,7 +1,7 @@
|
|||||||
# SSH config files
|
# SSH config files
|
||||||
|
|
||||||
## brief
|
## Why use ssh config files?
|
||||||
This is the first time for me using ssh config files so that's why this is a seperate file.
|
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
|
## 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.
|
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.
|
||||||
|
@@ -1,6 +1,6 @@
|
|||||||
# Customising mkdocs
|
# 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!
|
||||||
|
|
||||||

|

|
||||||
|
|
Reference in New Issue
Block a user