MKDocs Docker Setup

This repository contains a Docker-based setup for an MkDocs project. You can use this configuration to build and serve your MkDocs documentation in a containerized environment.

---

Repository Structure

.
├── Dockerfile
├── docker-compose.yml
├── entrypoint.sh
├── mkdocs.yml
└── README.md

• mkdocs.yml
  The main MkDocs configuration file. Customize site settings, plugins, and themes here.

• Dockerfile
  Defines the image that will be used to build and serve the MkDocs documentation. Installs necessary dependencies and configures SSH.

• docker-compose.yml
  Defines services for running MkDocs in Docker. This file references the Dockerfile and manages container creation, networking, volumes, etc.

• README.md
  This file.

• entrypoint.sh Clones or pulls the content of this repository in /docs inside the docker container everytime the container starts.

---

Getting Started

Prerequisites

• Docker
• Docker Compose

Github Authetication

You need a fine-grained Personal Access Token (PAT) for the documentation repository. This is required for the mike plugin to deploy new versions.

PAT

The PAT need this permissions:

• metadata (read)
• contents (read and write)

.env file

store the PAT in the .env file

GITHUB_TOKEN=your_personal_access_token

Clone the Repository

git clone https://github.com/maltonoloco/mkdocs
cd mkdocs

Run the Container

mkdir docs # create docs directory
docker-compose up -d

• docs/
  Contains all your MkDocs content files (Markdown files, images, etc.). These files are also available at mkdocs_test_doc repository.

Github Pages

The Documentation with versioning is here available