Docs

The documentation uses MkDocs to render the content.

Test changes

Option 1: Use Python locally

This method uses Python installed directly on your machine to run the MkDocs server.

1. Install Python and pip (if not already installed)

2. Create a virtual environment (recommended)

A virtual environment keeps dependencies isolated and avoids conflicts.

2.1 Create the virtual environment

Place it in a dedicated directory outside your project directory:

python3 -m venv ~/venvs/mkdocs-env

2.2 Activate the virtual environment

• Linux/macOS

source ~/venvs/mkdocs-env/bin/activate

• Windows (Command Prompt)

~/venvs/mkdocs-env\Scripts\activate

• Windows (PowerShell)

~/venvs/mkdocs-env\Scripts\Activate.ps1

2.3 Verify activation

The name of your environment should appear in brackets at the beginning of your command line.

3. Install the requirements

In your project directory, install the required dependencies:

pip3 install -r requirements.txt

4. Start the MkDocs server

4.1 Run the MkDocs development server:

mkdocs serve

4.2 Once the server is running, open your browser and visit http://127.0.0.1:8000.

Option 2: Use a Docker container

This method uses Docker to run the MkDocs server in an isolated container. All dependencies, including Python, are installed inside the container.

1. Build the Docker image

The Docker image bundles Python, MkDocs, and all necessary dependencies:

docker build . -t docs

2. Run the Docker container

Start the container and expose the documentation server locally:

docker run -it --rm -p 8000:8000 -v $PWD:/docs docs

3. The documentation server will be accessible at: http://127.0.0.1:8000.

Deployment

The main branch is automatically deployed to docs.strangebee.com.

If not:

mkdocs gh-deploy --remote-branch gh-pages