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 renvoyer 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’outils en ligne de commande
• Montrer comment appeler des points de terminaison d’API
• Et bien plus encore !

Ajouter un bloc de code

1. Pour ajouter un bloc de code, placez votre curseur sur une ligne vide et saisissez /.
2. Dans le menu d’insertion rapide, sélectionnez Bloc de code.
3. GitBook insère le bloc et place votre curseur à l’intérieur, prêt à coller ou à saisir du code.

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 les 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

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

Elixir

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

Options des blocs 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 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 langues prises 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 nous rattraperons bientôt !

filename.txt

// Du code

Avec numéros de ligne

Cela activera et 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 beaucoup de 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 scénarios similaires.

Avec légende

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

La légende est souvent le nom d’un fichier, comme dans notre exemple ci-dessus, mais vous pouvez aussi l’utiliser comme titre, description ou tout autre élément de votre choix.

Retour à la ligne du code

Cela activera et désactivera le retour à la ligne du code, de sorte que les longues lignes de code soient renvoyées 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 voulez éviter que le lecteur fasse défiler horizontalement pour le lire. Si vous l’activez Retour à la ligne du 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.

Extensible

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

La vue réduite 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 les blocs de code

En plus des options ci-dessus, vous pouvez également changer la langue d’affichage du bloc de code et copier instantanément votre code.

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