Skip to content

Deploying mkdocs template locally

Overview

This document describes how to deploy the MkDocs project on your local host.

Note

Normally, work should not be performed locally. The following instructions apply only in exceptional cases where local work becomes necessary.

Prerequisites

Step-by-Step Setup

Download package

  1. Navigate to project Gitlab
  2. Clone project to your local computer

Install Docker and Docker Compose

Make sure that Docker and Docker Compose are installed on your local host. If this is not yet the case, install them as described here: LINK to install manual

Run compose file

  1. Open your terminal and navigate to recently unpacked hetzner-docs path:

img_1.png

  1. Run this command in the terminal: docker compose up -d
  2. Check if the docker containers are up and running: docker ps

img_2.png

In the screenshot, the first docker container shows the contents of the EW documents: mkdocs-ew. The second docker container shows the contents of the LH documents: mkdocs-lh.

Browser local URL

Open in browser localhost:8073 and localhost:8071.

Both documents look the same, but if you open the tab External documents -> Docs -> TESTING, you will see that the same file has different content on each page.

The content is administered by parameters in the files:

/hetzner-docs/docker-compose.yml

/hetzner-docs/mkdocs_project/mkdocs.yml

/hetzner-docs/mkdocs_project/macros.py

img_3.png

Stopping containers

To stop the containers, run the following command in /hetzner-docs path: docker compose down.

Note

When changing in configuration files - containers must be restarted.

In case of changes in the documentation itself - restart of containers is not required.

Changelog

Date Author Message
2026-02-25 aresnikowa Merge remote-tracking branch 'origin/master'