Aller au contenu

Avant de démarrer

Pour utiliser ces tutos

  • Le langage utilisé est le Markdown. Principales syntaxes Markdown (Markdown). Nous verrons au fur et à mesure les syntaxes nécessaires
  • Nous utiliserons un vocabulaire spécifique présenté ici.
  • Le code peut être copié/collé en cliquant dans le tutoriel sur l'icône placée en haut à droite du code à copier copier
    Vous n'aurez plus qu'à effectuer un "coller" dans le document de votre site.

I. La structure du site⚓︎

Le choix retenu pour ces modèles est de construire un site dont la page d'accueil est le contenu généré depuis le fichier index.md et les pages suivantes sont prises par ordre alphabétique de nom de dossier/fichier.

Ainsi, si la structure du répertoire docs est la suivante (comme dans le site modèle) :

Une partie de la structure du modèle
docs/
├── 01_chapitre_1
│   └── chapitre_1.md
├── 02_chapitre_2
│   ├── scripts
│   │   ├── addition_REM.md
│   │   ├── addition.py
│   │   ├── premier_liste_REM.md
│   │   └── premier_liste.py
│   ├── 2_fonction.md
│   ├── 3_liste.md
│   └── .pages
├── index.md
├── .pages
└── tags.md
Le site construit affichera comme page d'accueil le contenu provenant de la page index.md, et en menu les titres spécifiés au début des fichiers avec pour extension .md comme expliqué ci-dessous.

Code à copier au début d'un fichier .md
---
author: compléter avec les noms d'auteurs
title: Compléter le titre qui sera affiché dans le menu
---
Séparer un chapitre en plusieurs pages

Si vous êtes amenés à séparer le contenu de votre chapitre en plusieurs pages, vous pouvez rajouter un fichier .pages qui contiendra le titre affiché au menu du site pour l'ensemble de ces pages.

Ici par exemple :

Code exemple d'un fichier .pages à recopier
title: Chapitre 2 - Python
En l'absence de ce fichier .pages le menu du site affichera le nom du dossier, c'est à dire ici chapitre 2 (et non Chapitre 2 - Python).

Le rendu du site modèle correspondant à cette structure est le suivant :

accueil

II. Le vocabulaire⚓︎

Indentation⚓︎

  • Une indentation est un décalage vers la droite de 4 espaces (souvent réalisé automatiquement avec la touche tabulation du clavier)

  • Un texte indenté est un texte pour lequel toutes les lignes sont indentées :

texte indenté
    Ceci est un texte indenté.  
    Toutes les lignes sont décalées de 4 espaces vers la droite.  
    Il ne faut pas oublier les indentations lorsqu'elles sont nécessaires.  
    C'est souvent la cause de problèmes de rendu.
texte non indenté
Ceci est un texte non indenté.  
Toutes les lignes commencent au début de la ligne.    
Il ne faut pas oublier les indentations lorsqu'elles sont nécessaires.  
C'est souvent la cause de problèmes de rendu.

Backtick ou apostrophe inversée⚓︎

Pour écrire un morceau de code dans un texte, Markdown l’identifie au moyen du caractère appelé le Backtick ou apostrophe inversée (`). Attention, à ne pas le confondre avec les guillemets. On le trouve généralement avec la touche ALT GR + è du clavier.

Les "admonitions"⚓︎

Les « admonitions » sont les « boîtes » comme celles-ci. Elles peuvent s'imbriquer les unes dans les autres.

Question

Résoudre cet exercice. Mon énoncé

Astuce 1

Ma belle astuce 1

Astuce 2

Ma belle astuce 2

Astuce 3

Ma belle astuce 3

Solution

La solution

Remarque

texte de la remarque indenté

Les "IDE"⚓︎

Nous appelons IDE une fenêtre dans laquelle nous pouvons écrire du code.

###(Dés-)Active le code après la ligne # Tests (insensible à la casse)
(Ctrl+I)
Entrer ou sortir du mode "deux colonnes"
(Ctrl+Clic pour inverser les colonnes)
Entrer ou sortir du mode "plein écran"
Tronquer ou non le feedback dans les terminaux (sortie standard & stacktrace / relancer le code pour appliquer)
Si activé, le texte copié dans le terminal est joint sur une seule ligne avant d'être copié dans le presse-papier

Tutoriel sur les IDE