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 envelopper les lignes. Il est également facile de copier le contenu d'un bloc de code dans le presse-papiers, afin que vous puissiez 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 endpoints d'API

• Et bien plus encore !

Exemple d'un 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 langues différentes :

JavaScript

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

Ruby

Elixir

Vous pouvez rendre les blocs de code occupant 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 plusieurs options que vous pouvez définir.

Définir la syntaxe…

Vous pouvez définir la syntaxe dans votre bloc de code pour n'importe quel langage pris en charge. Cela activera également la coloration syntaxique pour ce langage.

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 discordance entre GitBook et Prism, il se peut que nous soyons en retard d'une ou deux versions. Nous rattraperons bientôt notre retard !

filename.txt

// Du code

Avec numéros de ligne

Cela activera ou désactivera les 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 de nombreuses lignes. Masquer les numéros de ligne est utile pour des extraits, des instructions d'utilisation pour des expressions en ligne de commande ou terminal et des scénarios similaires.

Avec légende

Cela activera ou désactivera une légende qui se place 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 autre élément de votre choix.

Enrouler le code

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

Le renvoi à la ligne est utile lorsque votre code est long et que vous voulez éviter que le lecteur ait à faire défiler de gauche à droite pour le lire. Si vous activez Enrouler le code , vous voudrez peut-être aussi afficher les numéros de ligne — cela facilitera la lecture du code et la compréhension du début des nouvelles lignes.

Extensible

Cela activera ou désactivera l'affichage du code en entier (lorsque l'interrupteur est désactivé) ou une fenêtre repliée du code que l'utilisateur peut développer (lorsque l'interrupteur est activé).

La vue repliée affiche par défaut 10 lignes de code avec un bouton pour développer et afficher le bloc de code complet. S'il y a moins de 10 lignes de code, tout le contenu sera affiché.

Actions sur le 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

Survolez un bloc de code et un certain nombre d'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 %}