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"
(Alt+: ; Ctrl pour inverser les colonnes)
Entrer ou sortir du mode "plein Ă©cran"
(Esc)
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