Installing MkDocs on Ubuntu 24.04

Prompt:

best way to install mkdocs on ubunu 24.04

Response:

The best way to install MkDocs on Ubuntu 24.04 is by using Python’s package manager, pip, within a virtual environment. This method is the most reliable as it ensures you get the latest version of MkDocs and avoids conflicts with other Python packages on your system.

Prerequisites

Before you install MkDocs, you’ll need to make sure you have Python 3 and pip installed on your system. Ubuntu 24.04 comes with Python 3, but you might need to install pip and the venv module.

Open your terminal.

Install Python 3’s pip and the virtual environment module:

sudo apt update
sudo apt install python3-pip python3-venv -y

Installation Steps

Using a virtual environment is a best practice for Python development. It creates an isolated space for your project’s dependencies, preventing version conflicts with other projects.

Create a new project directory and navigate into it:
```
mkdir my-mkdocs-project
cd my-mkdocs-project
```
Create a virtual environment:
```
python3 -m venv venv
```
Activate the virtual environment:
```
source venv/bin/activate
```
Your terminal prompt should now be prefixed with (venv), indicating you are inside the virtual environment.
Install MkDocs and any desired themes, like mkdocs-material:
```
pip install mkdocs mkdocs-material
```
This command will download and install the latest versions of MkDocs and the Material for MkDocs theme, along with their dependencies, into your isolated environment.

Getting Started

Now that MkDocs is installed, you can create and serve a new project to verify it’s working.

Create a new project inside your activated virtual environment:
```
mkdocs new .
```
This creates a basic mkdocs.yml configuration file and a docs/ folder with an index.md file.
Start the development server to view your site:
```
mkdocs serve
```
You can now open a web browser and navigate to http://127.0.0.1:8000 to see your new documentation site. The server will automatically reload when you make changes to your files.
Deactivate the virtual environment when you’re done working:
```
deactivate
```