Guide d'Utilisation des Code Blocks

Ce guide présente les fonctionnalités avancées des code blocks dans la documentation TAAF.

---

1. Numéros de ligne automatiques

Par défaut, tous les code blocks affichent maintenant les numéros de ligne.

Exemple de base

def hello_world():
    print("Hello, TAAF!")
    return True

if __name__ == "__main__":
    hello_world()

Code Markdown:

```python
def hello_world():
    print("Hello, TAAF!")
    return True
```

---

2. Commencer à un numéro spécifique

Vous pouvez démarrer la numérotation à une ligne spécifique avec linenums="<numéro>".

Exemple : Démarrer à la ligne 10

# Configuration Wazuh
wazuh_server = "10.0.0.50"
wazuh_port = 1514

Code Markdown:

```python linenums="10"
# Configuration Wazuh
wazuh_server = "10.0.0.50"
wazuh_port = 1514
```

---

3. Désactiver les numéros de ligne

Pour désactiver les numéros sur un code block spécifique, utilisez linenums="0".

docker ps
docker logs wazuh-manager

Code Markdown:

```bash linenums="0"
docker ps
docker logs wazuh-manager
```

---

4. Surligner des lignes spécifiques

Utilisez hl_lines="<numéros>" pour mettre en évidence certaines lignes.

Exemple : Surligner les lignes 2 et 4

services:
  wazuh-manager:
    image: wazuh/wazuh-manager:latest
    privileged: true
    ports:
      - "1514:1514"

Code Markdown:

```yaml hl_lines="2 4"
services:
  wazuh-manager:
    image: wazuh/wazuh-manager:latest
    privileged: true
```

Surligner une plage de lignes

# Configuration Falco
falco_config = {
    "json_output": True,
    "log_level": "INFO",
    "priority": "WARNING"
}
# Règles personnalisées
custom_rules = "/etc/falco/rules.d/"

Code Markdown:

```python hl_lines="2-4 7"
# Configuration Falco
falco_config = {
    "json_output": True,
    "log_level": "INFO",
    "priority": "WARNING"
}
# Règles personnalisées
custom_rules = "/etc/falco/rules.d/"
```

---

5. Combiner numérotation personnalisée + surlignage

# Sur VM TAAF-DOCKER-001
cd /opt/taaf-docker
docker-compose up -d falco

# Vérifier les logs
docker logs falco-docker

Code Markdown:

```bash linenums="15" hl_lines="3 5-6"
# Sur VM TAAF-DOCKER-001
cd /opt/taaf-docker
docker-compose up -d falco

# Vérifier les logs
docker logs falco-docker
```

---

6. Titre de code block

Ajoutez un titre au-dessus du code block avec title="<titre>".

docker-compose.yml

version: '3.8'
services:
  wazuh-manager:
    image: wazuh/wazuh-manager:latest
    container_name: wazuh-manager
    privileged: true

Code Markdown:

```yaml title="docker-compose.yml"
version: '3.8'
services:
  wazuh-manager:
    image: wazuh/wazuh-manager:latest
```

---

7. Combiner toutes les fonctionnalités

wazuh_config.py

#!/usr/bin/env python3
# Configuration Wazuh TAAF

class WazuhConfig:
    def __init__(self):
        self.server = "10.0.0.50"
        self.port = 1514

    def connect(self):
        print(f"Connecting to {self.server}:{self.port}")
        return True

if __name__ == "__main__":
    config = WazuhConfig()
    config.connect()

Code Markdown:

```python title="wazuh_config.py" linenums="1" hl_lines="5-7 10"
#!/usr/bin/env python3
# Configuration Wazuh TAAF

class WazuhConfig:
    def __init__(self):
        self.server = "10.0.0.50"
        self.port = 1514
```

---

8. Langages supportés

Bash/Shell

#!/bin/bash
docker-compose ps

Python

def test():
    pass

YAML (Docker Compose, Kubernetes)

version: '3.8'
services:
  app:
    image: nginx

JSON

{
  "name": "TAAF",
  "version": "1.0.0"
}

PromQL (Prometheus)

rate(container_cpu_usage_seconds_total[5m])

LogQL (Loki)

{job="falco-security"} |= "postgres"

SQL

SELECT * FROM communications
WHERE date > '2024-01-01';

Dockerfile

FROM python:3.11-slim
WORKDIR /app
COPY . .
RUN pip install -r requirements.txt

---

9. Bonnes pratiques pour les TPs

DO : Numéros de ligne pour code long

# Code complexe avec plusieurs étapes
def deploy_wazuh():
    # Étape 1
    create_network()
    # Étape 2
    start_indexer()
    # Étape 3
    start_manager()

DO : Surligner les parties importantes

services:
  falco:
    privileged: true  # IMPORTANT : requis pour la détection
    image: falco/falco:latest

DO : Titre pour les fichiers de config

/etc/falco/falco.yaml

json_output: true
log_level: info

DON’T : Numéros de ligne pour commandes simples

docker ps

Utilisez plutôt :

docker ps

---

10. Code inline

Pour du code au milieu d’une phrase, utilisez les backticks simples :

Exécutez la commande docker-compose up -d pour démarrer les services.

Code Markdown:

Exécutez la commande `docker-compose up -d` pour démarrer les services.

---

Récapitulatif des options

Option	Syntaxe	Exemple
Langage	```<lang>	```python
Titre	title="<titre>"	title="app.py"
Numéros de ligne	linenums="<départ>"	linenums="1"
Désactiver numéros	linenums="0"	linenums="0"
Surligner lignes	hl_lines="<nums>"	hl_lines="2 4-6"

Exemple complet

```python title="config.py" linenums="10" hl_lines="12-14"
def configure_wazuh():
    # Configuration
    server = "10.0.0.50"
    port = 1514
    return True
```

---

Bonne documentation ! 📝