Aller au contenu principal

Blocs de code et extraits

DocStatic propose deux méthodes pour inclure du code dans votre documentation. Les deux prennent en charge la coloration syntaxique.

Blocs de code​

  1. Cliquez sur l'icône Bloc de code dans l'éditeur de texte enrichi.
  2. Cliquez sur la liste des langages et sélectionnez ou recherchez un langage.
  3. Saisissez votre code dans la zone.

Exemple :​

``` texte brut

Ceci est du texte brut.




## Extraits de code

1. Sélectionnez **Extrait de code** dans la liste **Intégrer**.
2. Donnez-lui un **Titre**.
3. Sélectionnez un **Langage**.
4. Choisissez un fichier dans la liste. La liste est remplie avec tous les fichiers du dossier `reuse/code/` chaque fois que vous exécutez le serveur de développement ou effectuez une compilation.

#### Exemple :

(jsx:CodeSnippet title="Exemple de titre" language="xml" filepath="example.xml")Exemple de titre(/jsx:CodeSnippet)

L'avantage d'utiliser des extraits de code est qu'il existe un fichier physique qui peut être testé individuellement.