Aller au contenu

Documentation des plugins

✏️ 1. Drawio :

Drawio est un logiciel en ligne d'édition de diagrames en tout genre, dans notre cas il sagit d'un schema réseau, l'utilisation de ce plugin permet de générer une API html interactive utilisant les fichier en .drawio, cela nous permet un zoom et une navigation simplifier du diagrame, de plus l'utilisation de cette API débloque certaines fonctionnalité comme les fenetres réductibles.

Modification du workflow.

Afin de pouvoir utiliser le plugin, il faut tout dabord l'installer, nous allons donc modifier le fichier main.yml de notre github, le but étant d'ajouter la commande qui installeras le plugin "drawio"

name: ci 
on:
  push:
    branches:
      - master 
      - main
permissions:
  contents: write
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Configure Git Credentials
        run: |
          git config user.name github-actions[bot]
          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
      - uses: actions/setup-python@v5
        with:
          python-version: 3.x
      - run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV 
      - uses: actions/cache@v4
        with:
          key: mkdocs-material-${{ env.cache_id }}
          path: ~/.cache 
          restore-keys: |
            mkdocs-material-
      - run: pip install mkdocs-material 
      - run: pip install mkdocs-drawio
      - run: mkdocs gh-deploy --force

Une fois le workflow modifier, github installeras le plugin "drawio" a chaque mise a jour du code.

Ajout du plugin dans le mkdocs.yml

Il faut ensuite ajouter le plugin dans le fichier de configuration mkdocs

plugins: 
  - drawio

Ajout du fichier drawio dans une page

Pour finir il ne reste plus qu'à insérer le fichier avec l'extention ".drawio" dans notre fichier makdown a la manière d'une image

![](fichier.drawio)

Search est un plugin qui permet d'ajouter une barre de recherche en haut a droite de votre page, cette barre de recherche permet de rechercher des mots, titres ou pages de votre document Mkdocs.

Activation ⚡

Ce plugin étant natif a Mkdocs, il suffit d'ajouter la ligne dans le fichier mkdocs.yml 

plugins: 
  - drawio 
  - search