Markdown
Dialectos / Sabores

Observaciones

Rebaja de desbordamiento de pila

Este es el tipo de reducción que utiliza Stack Overflow y otros sitios de Stack Exchange. Cuando respondes una pregunta o agregas documentación, utilizas esta marca. Esta respuesta está hecha de SO markdown

Ver documentación oficial

Las cosas principales que agrega SO markdown se encuentran en "Adiciones de Stack Exchange" en esa página web. En particular, SO agrega etiquetas como [tag:tag] y enlaces de acceso directo como [meta] (aunque no en la documentación), spoilers :

Esto es un spoiler

>! This is a spoiler

y devociones de idiomas personalizados

<!-- language: java -->
```
This text is formatted as if it were Java code
```

This text is formatted as if it were Java code

Doxygen Markdown

Doxygen es una herramienta de documentación de código de uso común (para lenguajes como C ++, C # y Java) que también admite el uso de Markdown. Además de la sintaxis estándar de Markdown, hay una serie de elementos específicos de Doxygen .

Las características principales son el uso de las etiquetas @ref para referencias, y los elementos @page , @section/@subsection y @anchor que se puede hacer referencia.

@ref <nombre> ["texto"]

Este elemento crea un enlace (es decir, referencia) a una sección, subsección, página o ancla con nombre que se ha definido en otra parte de la documentación. (ver referencia de Doxygen )

El primer parámetro ( name ) debe coincidir con el nombre de la sección, subsección, página o ancla que desea vincular.

El segundo parámetro opcional ( "text" ) debe encapsularse entre comillas dobles y definirá cómo aparecerá el enlace de referencia en la página. Si no se utiliza, el enlace aparecerá como el título utilizado en la referencia.

@section <section-name> (título de la sección)

Este elemento define un nombre de sección. Es visualmente equivalente a un elemento # en Markdown, sin embargo, también definirá una referencia a la que se puede vincular desde otras secciones de su documentación. (ver referencia de Doxygen )

El primer parámetro section-name define el nombre de referencia que puede ser usado por el elemento @ref . Esto no puede contener espacios.

El section title segundo parámetro de la section title es una cadena de palabras (que pueden estar separadas por espacios) que define el encabezado de la sección que aparecerá en su página.

Ejemplo

@section Intro Introduction

This is some text in my introduction.

@section Body Body Paragraph

This is some text in my body, where I refer to the @ref Intro.

Salida

Introducción

Este es un texto en mi introducción.

Cuerpo del párrafo

Este es un texto en mi cuerpo, donde me refiero a la Introducción.

NB: La palabra Introducción anterior aparecerá como un enlace que saltará al encabezado Introducción.

GitHub Con sabor Markdown

GitHub Flavored Markdown (a veces abreviado como GFM) facilita el trabajo con markdown en GitHub.com .

Las características clave de GFM incluyen:

• código de sangría
• soporte de lista de tareas
• fácil referencia a problemas de GitHub
• Nombre de usuario automático de GitHub y detección de SHA
• detección automática de url
• soporte emoji

Ejemplos de GFM

Resaltado de sintaxis

Con Markdown, se puede generar un bloque de código con tres backticks:

```

Sin el resaltado de sintaxis, el código escrito en C aparece así

#include <stdio.h>

int main(void)
{
    printf("Hello World\n");
    return (0);
}

Sin embargo, con el resaltado de sintaxis, el código escrito en C aparece así:

Para resaltar el código, simplemente agregue un identificador de idioma opcional para habilitar el resaltado de sintaxis en su bloque de código cercado.

```C
<code text here>
```

Estas mejoras están diseñadas para mejorar la calidad de la documentación y la conversación incluidas en los archivos, listas , solicitudes de extracción y problemas de README en la plataforma.