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 é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’outils en ligne de commande

• Montrer comment appeler des points de terminaison 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 langages différents :

JavaScript

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

Ruby

Elixir

Vous pouvez rendre les blocs de code occupent toute la largeur de votre fenêtre en cliquant sur 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 d’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 dans n’importe quelle langue prise 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 les langages pris en charge par Prism. Si vous remarquez une différence entre GitBook et Prism, il est possible que nous ayons une ou deux versions de retard. Nous rattraperons vite notre retard !

filename.txt

// Some 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 la ligne de commande 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 tout autre élément de votre choix.

Retourner 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 retour à la ligne est utile lorsque votre code est long et que vous voulez éviter que le lecteur fasse défiler horizontalement pour le lire. Si vous activez Retourner le code cela, 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.

Repliable

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

L’affichage réduit montre par défaut 10 lignes de code avec un bouton permettant de développer 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 d’affichage du bloc de code et copier votre code instantanément.

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