Sintaxis y buenas prácticas en Markdown

Exploramos la sintaxis básica de Markdown con ejemplos y compartimos algunas buenas prácticas para dar formato al texto de manera efectiva

Markdown se basa en una sintaxis simple y legible que te permite aplicar formato al texto de manera rápida y sencilla. A continuación, te mostraremos algunas de las características básicas de Markdown y cómo utilizarlas.

Encabezados

Para crear encabezados en Markdown, utiliza el símbolo "#" seguido de un espacio y el texto del encabezado. El número de "#" indica el nivel del encabezado, siendo "#" para encabezados de nivel 1, "##" para nivel 2 y así sucesivamente. Aquí tienes un ejemplo:

# Encabezado de Nivel 1

## Encabezado de Nivel 2

### Encabezado de Nivel 3

#### Encabezado de Nivel 4

Ejemplo:

Encabezado de Nivel 1

Encabezado de Nivel 2

Encabezado de Nivel 3

Encabezado de Nivel 4

Párrafos

Los párrafos en Markdown se crean simplemente escribiendo el texto sin ningún formato adicional. Deja una línea en blanco entre párrafos para separarlos:

Este es un párrafo.

Este es otro párrafo.

Énfasis

Puedes agregar énfasis al texto utilizando asteriscos (*) o guiones bajos (_). Para texto en cursiva, encierra las palabras o frases entre un par de asteriscos o guiones bajos:

_Texto en cursiva_
_Texto en cursiva_

Texto en cursiva
Texto en cursiva

Para texto en negrita, utiliza dos asteriscos o guiones bajos:

**Texto en negrita**
**Texto en negrita**

Texto en negrita
Texto en negrita

Listas

Markdown admite listas ordenadas y no ordenadas. Para crear una lista no ordenada, simplemente utiliza asteriscos, guiones o signos más seguidos de un espacio:

- Elemento 1
- Elemento 2
- Elemento 3

• Elemento 1
• Elemento 2
• Elemento 3

Para listas ordenadas, utiliza números seguidos de un punto y un espacio:

1. Primer elemento
2. Segundo elemento
3. Tercer elemento

1. Primer elemento
2. Segundo elemento
3. Tercer elemento

Enlaces

Para crear enlaces en Markdown, utiliza la siguiente sintaxis:

[Texto del enlace](URL)

Por ejemplo:

[Visita Webtutoriales](https://www.webtutoriales.com)

Visita Webtutoriales

Imágenes

Para insertar imágenes, utiliza una sintaxis similar a la de los enlaces, pero con un signo de exclamación (!) antes:

![Texto alternativo](URL de la imagen)

Citas

Para crear citas o bloques de texto citado, utiliza el símbolo ">" al comienzo de la línea:

> Esto es una cita.

Líneas horizontales

Puedes agregar líneas horizontales para separar secciones de tu documento utilizando tres guiones, tres asteriscos o tres signos más en una línea:

---

Se verá esta línea:

Escape de caracteres

Si necesitas incluir un caracter especial que normalmente tendría un significado en Markdown, como un asterisco o un guión bajo, puedes escaparlo utilizando una barra invertida (\):

\*Texto con asterisco\*

Tablas

Markdown permite crear tablas de una manera sencilla y legible. Las tablas se crean utilizando barras verticales | para delimitar las columnas y guiones - para separar la fila de encabezados de las filas de datos. Aquí tienes un ejemplo:

| Nombre | Líneas |
| ------ | ------ |
| Go     | 25     |
| Java   | 30     |
| Kotlin | 28     |

Bloques de código

Puedes utilizar bloques de código con resaltado de sintaxis para diferentes lenguajes. Especialmente para documentar código. Por ejemplo:

```js
function sum(a, b) {
  return a + b
}
```

Esto mostrará el código con resaltado de sintaxis para JavaScript:

function sum(a, b) {
  return a + b
}

Listas de tareas

Markdown admite listas de tareas que son útiles para llevar un registro de tareas pendientes o completadas. Utiliza el signo menos -, seguido de [ ] para una tarea pendiente o [x] para una tarea completada:

- [ ] Tarea pendiente
- [x] Tarea completada

• [ ] Tarea pendiente
• [x] Tarea completada

Citas con múltiples párrafos

Puedes incluir citas con múltiples párrafos utilizando el símbolo > al comienzo de cada párrafo de la cita:

> Esto es una cita.
>
> Esta es otra parte de la cita.

Esto es una cita.

Esta es otra parte de la cita.

Comentarios

Algunas implementaciones de Markdown, como GitHub Flavored Markdown (GFM), admiten comentarios que no se mostrarán en el documento final. Puedes utilizar <!-- para iniciar un comentario y --> para finalizarlo:

<!-- Este es un comentario y no se mostrará en la salida final -->

Notas al pie

Markdown también admite notas al pie para añadir explicaciones o referencias a pie de página. Esto varía según la implementación, pero un ejemplo podría ser:

[^1]: Esto es una nota al pie.

Y luego puedes referenciarlo en el texto principal como[^1].

Estas son algunas de las características avanzadas de Markdown que puedes utilizar para dar formato a tu contenido de manera efectiva. Con estas herramientas, puedes crear documentos más complejos y estructurados.

Buenas prácticas

Algunas recomendaciones a tener en cuenta:

• Usa encabezados de manera adecuada para organizar tu contenido.
• Separa párrafos con líneas en blanco para mejorar la legibilidad.
• Utiliza énfasis (cursiva y negrita) con moderación para resaltar información importante.
• Formatea tus listas de manera consistente y utiliza listas ordenadas cuando sea necesario.
• Añade enlaces y referencias de manera clara.
• Verifica la visualización de tu Markdown en diferentes entornos para asegurarte de que se vea como esperas.