Install

Description¶

Install and run MkDocs

Create venv¶

When a Python Virtual Env is activated for a proj, pip will install all the constricting snake stuff into [project_dir]/.venv. This isolates the proj with its own specific Python interpreter, and software libs and binaries.

Create .venv under proj dir:

cd [proj-dir]
python3 -m venv .venv

Activate venv¶

Activate Python virtual env:

source .venv/bin/activate

pip will now install every Python pkg into ./.venv until venv is deactivated or terminal is closed.

Add Shortcut to `.bash_aliases`¶

alias activate-venv="source ./.venv/bin/activate"

Install MkDocs¶

Install MkDocs, plus its plugins, themes and extensions:

pip isntall mkdocs
pip install mkdocs-material
pip install mkdocs-git-revision-date-localized-plugin
 ...