Discourse publica código o texto formateado

[honeymoose]

El texto proporciona instrucciones sobre cómo usar Markdown, BBCode y HTML para publicar texto con formato en Discourse.

Nivel de usuario requerido: Todos los usuarios pueden usarlo.

Enlace al artículo original: Posting code or preformatted text

Cuando hay código que se desea compartir en Discourse, o cuando se necesitan publicar registros de errores en Discourse. Si no formateamos el código, la lectura de este contenido será muy difícil, y muchos códigos contendrán espacios y otros caracteres, por lo que estos contenidos se desviarán de su significado original durante la conversión.

Resumen

En esta guía, puedes aprender:

• Cómo formatear código en línea.
• Cómo formatear código de una sola línea.
• Cómo formatear código de varias líneas.
• Cómo usar BBCode y HTML para formatear código.
• Cómo deshabilitar el formato automático de código.

Formato de código en línea

Para formatear código en línea o texto especial, usa comillas simples alrededor del contenido que necesitas formatear.

Esto puede estar en un texto, o el código puede estar en otra línea.

El formato de código en línea no aplicará ningún formato al código que se va a formatear (consulta el ejemplo a continuación), solo usará el estilo de código (“code style”) para el código que se va a formatear.

Ejemplo 1:

Entrada:

This is a line of code

Salida:

This is a line of code

Ejemplo 2:

Entrada:

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

Salida:

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

Formato de código de una sola línea

Si necesitas formatear código en una línea, solo necesitas agregar 4 espacios delante de la línea de código.

Todo el contenido en una sola línea se formateará como código hasta el inicio de la siguiente línea.

Ejemplo:

Entrada:

    All text after 4 spaces will be formatted.

Salida:

All text after 4 spaces will be formatted.

Formato de código de varias líneas

Para código de varias líneas, si todavía usas el formato de código de una sola línea, todo el proceso será muy engorroso.

Especialmente muchos códigos usarán espacios para la indentación.

El formato de código con espacios de una sola línea afectará la indentación de todo el bloque de código.

En este momento, puedes usar 3 comillas simples (backticks (```)) como inicio del código, estas 3 comillas simples deben estar en una línea separada.

Al mismo tiempo, no debe haber espacios antes de estas 3 comillas simples; si hay espacios, es posible que el bloque de código no se formatee.

Ejemplo:

Entrada:

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

Salida:

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

BBCode y HTML

Además del formato Markdown, Discourse también admite BBCode y HTML.

Para HTML, usa las etiquetas <pre> y <code>:

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

Para BBCode, usa la etiqueta [code]:

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

Para lenguajes de programación específicos

Por defecto, Discourse detectará automáticamente el lenguaje utilizado según el formato de tu entrada.

Por supuesto, también puedes especificar manualmente el lenguaje para el bloque de código, ingresando el lenguaje que deseas formatear después de las 3 comillas simples.

``` your_language
# Your code here

Ejemplo:

Para el lenguaje Ruby:

Entrada:

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

**Salida:**

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

Los lenguajes que se pueden admitir deben ser los lenguajes que admiten resaltado de sintaxis a continuación.

La lista de lenguajes admitidos se puede consultar en la página en GitHub.

Por supuesto, puedes usar la configuración default code lang para configurar el lenguaje predeterminado.

Sin resaltado de sintaxis

Si no deseas que el texto de entrada o el bloque de código utilicen ningún resaltado de sintaxis, usa text en lugar de la selección de lenguaje.

Ejemplo:

Entrada:

``` text
Your text to NOT highlight here

Salida:

Your text to NOT highlight here

Mejores prácticas

• Para código en línea, usa siempre comillas simples para encerrar el texto que necesitas formatear.
• Si vas a compartir varias líneas de código, formatea el código.
• Para texto y registros, evita usar el estilo de código automático, ya que estos textos son en su mayoría texto plano y el formato de texto es suficiente.
• Cuando descubras que el estilo automático no ha reconocido correctamente el código, recuerda especificar el lenguaje correcto para tu código.