Skip to content

MkDocs installieren

Wochenbericht KW33

Homebrew

Installation von Homebrew:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

Miniconda

Installation von miniconda mittels Homebrew:

brew install --cask miniconda

Standardmässig keine Umgebung aktivieren:

conda config --set auto_activate_base false

Python Environments

Für MkDocs eine Python-Umgebung erstellen, z.B. mit Python Version 3.9:

conda create --name env_name python=3.9

Aktivierung der Umgebung:

conda activate env_name

Umgebungen auflisten lassen (die aktive Umgebung wird immer mit einem * angezeigt):

conda info --envs

Aktive Python version überprüfen:

python --version

Python-Umgebung deaktivieren:

conda deactivate

mkdocs

Installation Mkdocs (mkdocs-material installiert auch mkdocs und alle anderen Abhängiigkeiten mit):

pip install mkdocs-material

pip sollte beim python packet mit installiert worden sein. Falls der obige Befehl nicht funktioniert zuerst einer der unteren Befehle ausführen und danach nochmals mkdocs installieren.

Upgrade, wenn pip schon vorhanden ist:

python install --upgrade pip

Installation von pip:

python get-pip.py

Initialisierung

Ein Projektverzeichnis erstellen und in das Verzeichnis gehen:

mkdir /path/to/myproject
cd /path/to/myproject/

Das Projektverzeichnis versionieren und ein neues MkDocs-Projekt starten:

git init
echo "site/" > .gitignore
mkdocs new .
git add .
git ci -m "Initial empty mkdocs project"

Last update: November 22, 2022