Skip to content

Commit

Permalink
installing mkdocs on your mac
Browse files Browse the repository at this point in the history
  • Loading branch information
Trikke76 committed Nov 18, 2023
1 parent f2b1221 commit d1ec2cc
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 1 deletion.
44 changes: 44 additions & 0 deletions How-to-instlall-mkdocs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# How to install MkDocs on OSX

This explains how to setup MkDocs on your Mac so that you can pull git on your pc and run the webserver local


## make sure brew is installed

```zsh
brew --version
```

## Install python 3

```zsh
brew install python3
```

## Install pip

```zsh
pip3 install --upgrade pip
```

## Install MkDocs

```zsh
pip3 install mkdocs
```

## Install MkDocs extension material

```zsh
pip3 install mkdocs-material
```

## Build your site local and test it

```
python3 -m mkdocs serve
```

```
python3 -m mkdocs build
```
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Since I am a huge fan of documetation in markdown or asciidoc I came up with the
The problem here is that it's probably not the best way to make a book readable so after some searching for a good solution based on markdown I found [MkDocs](www.mkdocs.org). MkDocs is a Python-Markdown library that can convert everything to HTML and can be templated.


# Who am i ?
# Who am I ?

My name is Patrik Uytterhoeven and I work for a Belgium company named Open-Future. I started at this company at Januari 2013 and thats
when my journey started with Zabbix aswel. They gave me the opportunity to build my experience and to get certified as Zabbix trainer.
Expand Down

0 comments on commit d1ec2cc

Please sign in to comment.