Conceptos básicos de Markdown

Introducción

Esta guía ofrece una introducción completa a los fundamentos de Markdown en Quarto, incluyendo una serie de opciones de formato y funciones avanzadas para mejorar tus proyectos de documentación.

Esto es lo que aprenderás:

  • Formateo de texto: Aprenda a aplicar estilos de texto esenciales como la negrita, la cursiva y los encabezados para estructurar su documento de forma eficaz.
  • Creación de listas: Comprender cómo organizar la información con claridad utilizando listas ordenadas y no ordenadas.
  • Creación de tablas: Obtén los conocimientos necesarios para montar tablas legibles que mejoren la presentación de los datos.
  • Incorporación de medios: Descubra cómo incrustar imágenes, diagramas y vídeos para que su contenido resulte más atractivo.
  • Mejora de la navegación: Utilice referencias cruzadas para enlazar varias partes de sus documentos sin problemas, mejorando la experiencia de navegación del lector.

Esta guía le garantiza que dispone de todas las herramientas necesarias para mejorar su documentación, haciéndola accesible y con un formato profesional. Ya sea que estés compilando un informe técnico, material educativo o cualquier documentación extensa, dominar estos conceptos básicos de Markdown mejorará significativamente tu capacidad para presentar la información de manera clara e interactiva.



Encabezamientos

Markdown admite seis niveles de encabezados: # representa el nivel más alto (encabezado 1) y ###### el más bajo (encabezado 6).

Sintaxis:

# Encabezado 1
## Encabezado 2
### Encabezado 3
#### Encabezado 4
##### Encabezado 5
###### Encabezado 6

Salida:

Encabezado 1

Encabezado 2

Encabezado 3

Encabezado 4

Encabezado 5
Encabezado 6

Formato del texto

Sintaxis:

- *italics*, **bold**, ***bold italics***
- superscript^2^ / subscript~2~
- ~~strikethrough~~
- `verbatim code`

Salida:

  • italics, bold, bold italics
  • superscript2 / subscript2
  • strikethrough
  • verbatim code

Listas

Sintaxis:

* lista desordenada
    + sub-elemento 1
    + sub-elemento 2
        - sub-sub-elemento 1

Salida:

  • lista desordenada
    • sub-elemento 1
    • sub-elemento 2
      • sub-sub-elemento 1

Sintaxis:

*   artículo 2
        
    Continúa (sangría 4 espacios)

Salida:

  • artículo 2

    Continúa (sangría 4 espacios)

Sintaxis:

1. lista ordenada
2. artículo 2
    i) sub-elemento 1
         A.  sub-sub-elemento 1

Salida:

  1. lista ordenada
  2. artículo 2
    1. sub-elemento 1
      1. sub-sub-elemento 1

Sintaxis:

(@)  Una lista cuya numeración
                   
continúa después de
                 
(@)  una interrupción

Salida:

  1. Una lista cuya numeración

continúa después de

  1. una interrupción

Sintaxis:

::: {}
1. Lista A
:::
::: {}
1. Seguido de otra lista
:::

Salida:

  1. Lista A
  1. Seguido de otra lista

Sintaxis:

término
: definición

Salida:

término
definición

Tenga en cuenta que a diferencia de otros renderizadores de Markdown (en particular Jupyter y GitHub), las listas en Quarto requieren una línea en blanco por encima de la lista. De lo contrario, la lista no se mostrará en forma de lista, sino que aparecerá como texto normal a lo largo de una sola línea.

Tablas

Código Markdown

| Derecha | Izquierda | Por defecto | Centro |
|------:|:-----|---------|:------:|
|   12  |  12  |    12   |    12  |
|  123  |  123 |   123   |   123  |
|    1  |    1 |     1   |     1  |

Salida

Derecha Izquierda Por defecto Centro
12 12 12 12
123 123 123 123
1 1 1 1

Diagramas

Quarto tiene soporte nativo para incrustar diagramas Mermaid y Graphviz.

Editores en vivo para mejorar su productividad en la creación de diagramas:

  1. El Mermaid Live Editor es una herramienta en línea para editar y previsualizar diagramas Mermaid en tiempo real.
  2. Graphviz Online proporciona una herramienta similar para editar diagramas Graphviz.

Crear un diagrama de flujo con Mermaid:

```{mermaid}
flowchart LR
  A[Hard edge] --> B(Round edge)
  B --> C{Decision}
  C --> D[Result one]
  C --> E[Result two]
```

flowchart LR
  A[Hard edge] --> B(Round edge)
  B --> C{Decision}
  C --> D[Result one]
  C --> E[Result two]

Un grafo simple no dirigido creado con graphviz:

```{dot}
graph G {
  layout=neato
  run -- intr;
  intr -- runbl;
  runbl -- run;
  run -- kernel;
  kernel -- zombie;
  kernel -- sleep;
  kernel -- runmem;
  sleep -- swap;
  swap -- runswap;
  runswap -- new;
  runswap -- runmem;
  new -- runmem;
  sleep -- runmem;
}
```

G run run intr intr run--intr kernel kernel run--kernel runbl runbl intr--runbl runbl--run zombie zombie kernel--zombie sleep sleep kernel--sleep runmem runmem kernel--runmem sleep--runmem swap swap sleep--swap runswap runswap swap--runswap runswap--runmem new new runswap--new new--runmem

Leer más sobre diagramas en Quarto.

Vídeos

Incluye un vídeo de YouTube:

{{< video https://www.youtube.com/embed/wo9vZccmqwc >}}

Ejemplos adicionales que demuestran el uso de varias fuentes y opciones de vídeo:

{{< video local-video.mp4 >}}

{{< video https://www.youtube.com/embed/wo9vZccmqwc >}}

{{< video https://youtu.be/wo9vZccmqwc width="400" height="300" >}}

{{< video https://www.youtube.com/embed/wo9vZccmqwc
    title="What is the CERN?"
    start="116"
    aspect-ratio="21x9" 
>}}

Leer más sobre vídeos en Quarto.

Saltos de página

Inserte un salto de página con el shortcode páginabreak:

página 1

{{< páginabreak >}}

página 2

Se admiten saltos de página nativos para HTML, LaTeX, Context, MS Word, Open Document y ePub.

Bloques de llamada

Código Markdown

:::{.callout-note}
Tenga en cuenta que hay cinco tipos de llamadas, incluyendo: 
`note`, `tip`, `warning`, `caution`, and `important`.
:::

Salida

Nota

Tenga en cuenta que hay cinco tipos de llamadas, incluyendo note, tip, warning, caution, and important.

Tip

Este es un consejo.

Advertencia

Esto es una advertencia.

Precaución

Esto es una advertencia.

Importante

Esto es importante.

Anotaciones en el código

Las anotaciones de celdas de código implican:

  1. Termina cada línea anotada con un comentario y un número de anotación entre paréntesis angulares (como # <2>). Utilice el mismo número para extender una anotación a lo largo de varias líneas.
  2. Añadir una lista ordenada justo después de la celda de código, donde cada elemento coincide con un número de anotación en el código.

Sintaxis:

```r
x <- 1:10  # <1>
y <- x^2   # <2>
z <- x^3   # <2>
```
1. Crear un vector `x`, y luego,
2. calcular `y` and `z`

Salida:

1x <- 1:10
2y <- x^2
z <- x^3
1
Crear un vector x, y luego,
2
calcular y and z

Las posibles posiciones de las anotaciones para la salida HTML son:

  • below (por defecto): Las anotaciones aparecen por defecto debajo de la celda de código.
  • hover: Las anotaciones se muestran al pasar el ratón sobre un marcador de línea.
  • select: Las anotaciones aparecen cuando se hace clic en un marcador y se pueden descartar haciendo clic de nuevo.

Para cambiar la posición predetérminoinada de las anotaciones, utilice el campo de metadatos code-annotations en el encabezado del documento:

---
code-annotations: hover
---

Referencias

Conceptos básicos de Quarto Markdown