-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
45 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters