Mkdocs sous Docker

J'utilise donc Mkdocs sous Docker pour faire cette documentation.

Conseil : faire le tuto proposé par Docker (docker/getting-started)

Le fichier docker-compose.yml

Creer un fichier nommé docker-compose.yml contenant ceci:

version: '3'

services:
  mkdocs:
    container_name: mkdocs_mkdocs
    image: polinux/mkdocs
    ports:
      - "8000:8000"
    environment:
      LIVE_RELOAD_SUPPORT: 'true'
      ADD_MODULES: 'fontawesome-markdown mkdocs-git-revision-date-localized-plugin mkdocs-material'
      FAST_MODE: 'true'
      DOCS_DIRECTORY: '/mkdocs'
      AUTO_UPDATE: 'false'
    volumes:
      - /d/FRED/GIT/tests_docker/mkdocs/mkdocs:/mkdocs

Il faut modifier la partie container_name de manière a avoir un nom unique qui n'existe pas déjà dans les conteneurs.

Vous pouvez modifier le port exposé c à d le premier 8000 si vous avez besoin de faire plusieurs mkdocs en //.

La partie volumes: doit être adaptée:

cette ligne sert a partager un répertoire Windows avec le conteneur Docker.

la partie /d/FRED/GIT/tests_docker/mkdocs/mkdocs est le PATH sous Windows a changer; c'est un PATH complet; apparemment la syntaxe bash git est supportée: le /d remplace le D: !!

Premier démarrage:

docker-compose up -d

Si votre répertoire de départ est vide mkdocs va creer les fichiers de départ c'est à dire mkdocs.yml et docs/index.md.

ensuite j'utilise DOCKER DESKTOP pour redemarrer.

Rajouter le theme Material:

mon fichier mkdocs.yml:

site_name: Notes Docker et Mkdocs

theme:
  name: material
  language: fr
  palette:
    primary: black

Liens

Syntaxe des pages (fichier.md) : Markdown.

Mkdocs.