Guide pour rédiger des exemples de commandes shell

Qu'est-ce qu'un « shell »

Un shell est un programme qui attend que vous saisissiez une commande puis appuyiez sur la touche Entrée. Pour indiquer quelles commandes vous devez saisir, le contenu sur MDN Web Docs les présente dans un bloc de code, comme pour les autres exemples de code.

Un tel bloc ressemble à ceci :

# Cela peut prendre un certain temps…
git clone https://github.com/mdn/content
cd content

General guidelines for shell prompt code examples

Choisir un format

Les opinions sur l'indentation correcte, les espaces et la longueur des lignes ont toujours été controversées. Les discussions sur ces sujets détournent de la création et de la maintenance du contenu.

Sur MDN Web Docs, nous utilisons Prettier ^(angl.) comme formateur de code pour garder un style cohérent (et éviter les discussions hors sujet). Vous pouvez consulter notre fichier de configuration ^(angl.) pour connaître les règles actuelles, et lire la documentation de Prettier ^(angl.).

Prettier formate tout le code et maintient un style cohérent. Cependant, il existe quelques règles supplémentaires à suivre.

Rédiger des blocs de code shell

Lorsque vous rédigez un bloc de code shell :

• N'incluez pas de « $ » ou de « > » au début d'une instruction shell. Cela perturbe plus qu'il n'aide et n'est pas utile pour copier les instructions.
• Les commentaires commencent par « # ».
• Choisissez « bash » pour indiquer le langage dans le markdown.

Voir aussi

Les documents de développement côté serveur Django montrent une bonne pratique de présentation des commandes de l'invite shell sur le MDN.