Blocs de code

Ajoutez un bloc de code à une page pour inclure des exemples de code, des configurations, des extraits de code et plus encore

Vous pouvez ajouter du code à vos pages GitBook en utilisant des 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 activer le retour à la ligne. Il est également 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

• Montrer 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 également combiner des blocs de code avec un bloc d’onglets pour proposer le même exemple de code dans plusieurs langages différents :

JavaScript

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

Ruby

greeting = lambda {|name| puts "Hello, #{name}!"}
greeting.("Anna")

Elixir

greeting = fn name -> IO.puts("Hello, #{name}!") end
greeting.("Anna")

Vous pouvez faire en sorte que les blocs de code occupent toute la largeur de votre fenêtre en cliquant sur le menu Options à côté du bloc et en choisissant Pleine largeur.

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 quel langage pris en charge. Cela activera également la coloration syntaxique dans ce langage.

Nous utilisons Prism pour la coloration syntaxique. Vous pouvez utiliser Test Drive Prism pour vérifier quels langages sont pris en charge par Prism. Si vous remarquez une différence entre GitBook et Prism, il se peut que nous ayons une version ou deux de retard. Nous rattraperons bientôt !

filename.txt

// Du code

Avec numéros de ligne

Cela activera ou désactivera l’affichage des numéros de ligne pour votre code.

Afficher les 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 beaucoup de lignes. Masquer les numéros de ligne est utile pour les extraits, les instructions d’utilisation pour la ligne de commande ou le terminal et des scénarios similaires.

Avec légende

Cela activera ou désactivera une légende qui s’affiche en haut du bloc, au-dessus de vos lignes de code.

La légende est souvent le nom d’un fichier comme montré dans notre exemple ci-dessus, mais vous pouvez aussi l’utiliser comme titre, description, ou tout ce que vous souhaitez.

Retour à la ligne du code

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

Le retour à la ligne est utile lorsque votre code est long et que vous souhaitez éviter que le lecteur ait à faire défiler horizontalement pour le lire. Si vous activez Retour à la ligne du code, vous voudrez peut-être aussi afficher les numéros de ligne — cela facilitera la lecture du code et la compréhension de l’emplacement des nouvelles lignes.

Actions du bloc de code

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

Copier le code

Survolez 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 %}