Skip to content

Secunda – Site de documentation (MkDocs + GitLab Pages)

Objectif

Créer un site de documentation simple et propre, et le publier gratuitement en utilisant GitLab Pages. Ce site permet de regrouper et présenter les exercices de la formation.

Fichiers importants

  • mkdocs.yml : configuration du site (nom, menu, navigation)
  • docs/index.md : page d’accueil du site
  • .gitlab-ci.yml : pipeline CI pour construire et publier le site automatiquement

Fichier CI (.gitlab-ci.yml)

Ce fichier permet de publier automatiquement le site avec GitLab Pages.

image: python:3.11

stages:
  - deploy

pages:
  stage: deploy
  script:
    - pip install mkdocs mkdocs-material
    - mkdocs build --site-dir public
  artifacts:
    paths:
      - public
  rules:
    - if: $CI_COMMIT_BRANCH == "main"

Exemple : mkdocs.yml

site_name: Documentation d’Ahmad

nav:
  - Accueil: index.md
  - Exercices:
    - Liste des exercices: exercises.md
    - Prima: prima.md
    - Secunda: secunda.md
    - Tertia: tertia.md
    - Quarta: quarta.md
    - Quinta: quinta.md
    - Sexta: sexta.md
    - Septima: septima.md
    - Octavia: octavia.md
    - Nona: nona.md
  - Guide (mise à jour): update-doc.md

theme:
  name: material

Exemple : docs/index.md

# Documentation d’Ahmad
Bienvenue 👋  
Je m’appelle **Ahmad Abo-Alola**.

## Contact
- Email : <Ahmadola111@gmail.com>
- GitLab : <https://gitlab.com/ahmadola111>

Ce que j’ai appris

  • MkDocs permet de créer un site à partir de fichiers Markdown (.md)
  • Le fichier mkdocs.yml permet de gérer la navigation du site
  • GitLab Pages offre un hébergement gratuit
  • Le pipeline CI publie automatiquement le site après chaque commit

Liens