Blocs de code

Ajoutez un bloc de code à une page pour inclure du code d’exemple, des configurations, des extraits de code et plus encore

Vous pouvez ajouter du code à vos pages GitBook à l’aide de blocs de code.

Lorsque vous ajoutez un bloc de code, vous pouvez choisir de définir la syntaxe, afficher les numéros de ligne, afficher une légende, et retourner les lignes. Il est aussi facile de copier le contenu d’un bloc de code dans le presse-papiers, afin de pouvoir l’utiliser ailleurs

Un bloc de code peut être utile pour :

• Partager des configurations

• Ajouter des extraits de code

• Partager des fichiers de code

• Afficher des exemples d’utilisation d’utilitaires en ligne de commande

• Montrer comment appeler des points de terminaison d’API

• Et bien plus encore !

Exemple de bloc de code

index.js

‌import * as React from 'react';
import ReactDOM from 'react-dom';
import App from './App';

ReactDOM.render(<App />, window.document.getElementById('root'));

Vous pouvez aussi combiner des blocs de code avec un bloc d’onglets pour proposer le même exemple de code dans plusieurs langues différentes :

JavaScript

let greeting = function (name) {
  console.log(`Bonjour, ${name} !`);
};
greeting("Anna");

Ruby

Elixir

Options du bloc de code

Lorsque vous cliquez sur le menu Options à côté du bloc de code, ou sur le menu Actions dans le bloc lui-même, vous verrez un certain nombre d’options que vous pouvez définir.

Définir la syntaxe…

Vous pouvez définir la syntaxe de votre bloc de code sur n’importe lequel des langages pris en charge. Cela activera également la coloration syntaxique dans cette langue.

Nous utilisons Prism pour la coloration syntaxique. Vous pouvez utiliser Test Drive Prism pour vérifier quels langages Prism prend en charge. Si vous remarquez une différence entre GitBook et Prism, il est possible que nous soyons en retard d’une ou deux versions. Nous rattraperons bientôt notre retard !

fichier.txt

// Quelques lignes de code

Avec numéros de ligne

Cela activera ou désactivera les numéros de ligne pour votre code.

L’affichage des numéros de ligne est utile lorsque le code représente le contenu d’un fichier dans son ensemble, ou lorsque vous avez de longs blocs de code avec de nombreuses lignes. Masquer les numéros de ligne est utile pour les extraits, les instructions d’utilisation pour les commandes en ligne ou les expressions de terminal et des cas similaires.

Avec légende

Cela activera ou désactivera une légende située en haut du bloc, au-dessus de vos lignes de code.

La légende est souvent le nom d’un fichier, comme indiqué dans notre exemple ci-dessus, mais vous pouvez aussi l’utiliser comme titre, description ou pour tout autre usage souhaité.

Retourner le code

Cela activera ou désactivera le retour à la ligne du code, afin que les longues lignes de code soient renvoyées à la ligne pour être toutes visibles en même temps sur la page.

Le retour à la ligne est utile lorsque votre code est long et que vous souhaitez éviter que le lecteur doive faire défiler horizontalement pour le lire. Si vous activez Retourner le code , vous pouvez aussi afficher les numéros de ligne — cela facilitera la lecture du code et la compréhension de l’endroit où commencent les nouvelles lignes.

Dépliable

Cela activera l’affichage du code en entier (lorsque le bouton est désactivé) ou d’une fenêtre réduite du code que l’utilisateur peut développer (lorsque le bouton est activé).

L’affichage réduit montre par défaut 10 lignes de code avec un bouton permettant d’afficher le bloc de code complet. S’il y a moins de 10 lignes de code, tout le contenu sera affiché.

Actions du bloc de code

En plus des options ci-dessus, vous pouvez également changer la langue affichée par le bloc de code et copier votre code instantanément.

Copier le code

Passez la souris sur un bloc de code et plusieurs icônes apparaîtront. Cliquez sur l’icône du milieu pour copier le contenu du bloc de code dans votre presse-papiers.

Représentation en Markdown

{% code title="index.js" overflow="wrap" lineNumbers="true" %}

```javascript
‌import * as React from 'react';
import ReactDOM from 'react-dom';
import App from './App';

ReactDOM.render(<App />, window.document.getElementById('root'));
```

{% endcode %}