mirror of
https://gitlab.waag.org/make/fablab/interns/2025/sam.git
synced 2025-08-03 11:54:58 +00:00
fixed typos
This commit is contained in:
@@ -1,13 +1,13 @@
|
||||
# How to set up your own documentation page using mkdocs
|
||||
|
||||
## 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.
|
||||
Mkdocs generates HTML from Markdown making an easy documentation page. So you don't have to struggle with html and css so you can focus on things more important.
|
||||
|
||||
## 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.
|
||||
|
||||
### Step 1 choosing a theme
|
||||
In [this](https://github.com/mkdocs/catalog) github repo there is a catalog if themes that you can choose. I went with the Ivory theme.
|
||||
In [this](https://github.com/mkdocs/catalog) github repo there is a catalog of themes that you can choose. I went with the Ivory theme.
|
||||
|
||||
### Step 2 preparing the envoirment
|
||||
You wanna create a couple of files. These all need to be in the root of your project.
|
||||
@@ -16,27 +16,26 @@ You wanna create a couple of files. These all need to be in the root of your pro
|
||||
* `.gitlab-ci.yml` The script that builds and deploys you page
|
||||
|
||||
#### mkdocs.yml
|
||||
Lets start with mkdocs.yml. In this file is described how to page should look and be named. This is the base of a mkdocs file.
|
||||
Lets start with mkdocs.yml. In this file is described how to page should look and be named. This is the base of a mkdocs file:
|
||||
```
|
||||
site_name: My Docs by GitLab Pages
|
||||
site_url: https://pages.gitlab.io/mkdocs
|
||||
site_dir: public
|
||||
theme: ivory
|
||||
```
|
||||
In here you can describe the site name and add the theme
|
||||
In here you can describe the site name and add the theme.
|
||||
|
||||
#### requirements.txt
|
||||
requirements.txt tell the python package manager what dependencies you want installed. For this project we need mkdocs and the theme you want to install.
|
||||
requirements.txt tell the python package manager (pip) what dependencies you want installed. For this project we need mkdocs and the theme you want installed.
|
||||
This is my requirements file
|
||||
```requirements.txt
|
||||
mkdocs>=1.5.3
|
||||
mkdocs-ivory>=0.4.6
|
||||
```
|
||||
You see that I install mkdocs and the theme
|
||||
To find the version number of the theme you need to open the package website and there you can see what version number its on.
|
||||
To find the version number of the theme you want you need to open the package website and there you can find what the latest version it's on.
|
||||
|
||||
#### gitlab-ci.yml
|
||||
gitlab-ci.yml tells gitlab what to do when a commit is send out. For example this yml file builds a page and publishes it
|
||||
gitlab-ci.yml tells gitlab what to do when a commit is send out. For example this yml file builds a page and publishes it.
|
||||
```yml
|
||||
image: python:latest
|
||||
|
||||
|
@@ -1,7 +1,7 @@
|
||||
# SSH config files
|
||||
|
||||
## 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.
|
||||
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. For example: instead of `ssh user@serveradress.co` you can type `ssh hostname` and that saves some brainpower for the rest of the fabacademy!
|
||||
|
||||
## 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.
|
||||
|
Reference in New Issue
Block a user