2025-05-31 2:29:34 PM

Status:

Tags:

Ubuntu Server 24.04.2 LTS Linux

venv Instructions (I'm using these)

Create a directory where you want MkDocs to live and move into it:

sudo mkdir ~/knowledge-base

cd ~/knowledge-base

Create the virtual environment:

sudo python3 -m venv .venv

Activate it:

source .venv/bin/activate

Install MkDocs and extensions inside the venv:

pip install mkdocs pymdown-extensions

[!NOTE] Note The pymdown-extensions is what will let you have clickable links in your pages without having to manually format each of them. Plain text links will just become clickable by default.

Optional: Install this if you plan to use popular themes or plugins (I did this):

pip install mkdocs-material

Verify with:

mkdocs --version

Non-venv Instructions (I'm not using these because you can't install extensions)

[!NOTE] Note Don't follow these instructions unless you have some reason you don't want to use the venv method. These instructions do work, but they don't allow you to install extensions. It's also worth noting that my system doesn't allow the use of pip, which is why this section uses pipx.

Run this command to install MkDocs:

pipx install mkdocs

Verify with:

mkdocs --version

References