Discourse publie du code ou du texte formaté

Wiki de la communauté Utilisateurs
1

:bookmark: Ce document explique comment utiliser Markdown, BBCode et HTML pour publier du texte formaté dans Discourse.

:person_raising_hand: Niveau d’utilisateur requis : Tous les utilisateurs peuvent utiliser

:link: Lien vers le document original : Posting code or preformatted text

Lorsque vous souhaitez partager du code dans Discourse, ou lorsque vous devez publier des journaux d’erreurs sur Discourse. Si nous ne formons pas le code, il est très difficile de lire ce contenu, et de nombreux codes contiennent des espaces et d’autres caractères, de sorte que ces contenus perdront leur sens d’origine lors de la conversion.

Sommaire

Dans ce guide, vous apprendrez :

  • Comment formater le code en ligne.
  • Comment formater le code sur une seule ligne.
  • Comment formater le code sur plusieurs lignes.
  • Comment utiliser BBCode et HTML pour le formatage du code.
  • Comment désactiver le formatage automatique du code.

Formatage du code en ligne

Pour formater du code en ligne ou du texte spécial, utilisez des apostrophes simples avant et après le contenu à formater.

Cela peut être dans un texte, ou le code peut être sur une autre ligne.

Le formatage du code en ligne n’appliquera aucun format au code à formater (voir l’exemple ci-dessous), il utilisera uniquement le style de code (“code style”) pour le code à formater.

Exemple 1 :

Entrée :

This is a line of code

Sortie :

This is a line of code

Exemple 2 :

Entrée :

Here’s some text with a bit of code inside!

Sortie :

Here’s some text with a bit of code inside!

Formatage du code sur une seule ligne

Si vous devez formater du code sur une seule ligne, il suffit d’ajouter 4 espaces avant le code de cette ligne.

Tout le contenu d’une seule ligne sera formaté en code jusqu’au début de la ligne suivante.

Exemple :

Entrée :

    All text after 4 spaces will be formatted.

Sortie :

All text after 4 spaces will be formatted.

Formatage du code sur plusieurs lignes

Pour le code sur plusieurs lignes, si vous utilisez toujours le formatage sur une seule ligne, l’ensemble du processus sera très gênant.

Surtout, de nombreux codes utilisent des espaces pour l’indentation.

L’utilisation du formatage de code avec des espaces sur une seule ligne affectera l’indentation de l’ensemble du bloc de code.

Dans ce cas, vous pouvez utiliser 3 apostrophes simples (backticks (```)) comme début du code, ces 3 apostrophes simples doivent être sur une ligne indépendante.

De plus, il ne doit pas y avoir d’espace avant ces 3 apostrophes simples, sinon le bloc de code pourrait ne pas être formaté.

Exemple :

Entrée :

``` 
public class CodeFormatting {
    public static void main(String[] args) {
        System.out.println("I can format code now!");
    }
}
```

Sortie :

public class CodeFormatting {
    public static void main(String[] args) {
        System.out.println("I can format code now!");
    }
}

BBCode et HTML

En plus du formatage Markdown, Discourse prend également en charge BBCode et HTML.

Pour HTML, utilisez les balises <pre> et <code> :

<pre><code>
public class CodeFormatting {
    public static void main(String[] args) {
        System.out.println("I can format code now!");
    }
}
</code></pre>

Pour BBCode, utilisez la balise [code] :

[code]
public class CodeFormatting {
    public static void main(String[] args) {
        System.out.println("I can format code now!");
    }
}
[/code]

Pour des langages de programmation spécifiques

Par défaut, Discourse détecte automatiquement le langage utilisé en fonction de votre format d’entrée.

Bien sûr, vous pouvez également spécifier manuellement le langage pour un bloc de code en tapant le langage que vous souhaitez formater après les 3 apostrophes simples.

``` your_language
# Your code here

Exemple :

Pour le langage Ruby :

Entrée :

``` ruby
3.times do |stuff|
    stuff.do
end
```

Sortie :

3.times do |stuff|
    stuff.do
end

Les langages pris en charge doivent être parmi les langages dont la coloration syntaxique est prise en charge.

La liste des langages pris en charge peut être consultée sur GitHub.

Bien sûr, vous pouvez utiliser le paramètre default code lang pour configurer le langage par défaut.

Ne pas utiliser la coloration syntaxique

Si vous ne souhaitez pas que le texte d’entrée ou le bloc de code utilise une coloration syntaxique, utilisez text à la place de la sélection du langage.

Exemple :

Entrée :

``` text
Your text to NOT highlight here

Sortie :

Your text to NOT highlight here

Meilleures pratiques

  • Pour le code en ligne, utilisez toujours des apostrophes simples pour entourer le texte que vous souhaitez formater.
  • Si vous souhaitez partager du code sur plusieurs lignes, formatez le code.
  • Pour le texte et les journaux, évitez d’utiliser le style de code automatique, car ces textes sont principalement du texte brut, utilisez simplement le format texte.
  • Lorsque vous constatez que le style automatique n’a pas correctement reconnu le code, n’oubliez pas de spécifier le bon langage pour votre code.
2 « J'aime »