La Guía Definitiva de Markdown: Sintaxis, Previsualización y Mejores Prácticas

Markdown es un lenguaje de marcado ligero con una sintaxis de formato de texto plano. Se utiliza ampliamente para archivos README, documentación y publicaciones de blogs. Debido a que es fácil de leer y escribir, Markdown se ha convertido en el estándar para la comunicación entre desarrolladores.

Utiliza esta hoja de referencia como una referencia rápida para la sintaxis estándar de Markdown y GitHub Flavored Markdown (GFM).

---

1. Formato de Texto

Estilos básicos para tu texto.

Elemento	Sintaxis	Resultado
Encabezados	# H1 a ###### H6	H1 a H6
Negrita	**texto** o __texto__	texto
Itálica	*texto* o _texto_	texto
Tachado	~~texto~~	texto
Cita	> cita	> cita
Regla Horizontal	--- o ***

---

2. Listas

Organiza tu contenido con listas ordenadas, desordenadas o de tareas.

• Lista Desordenada: Usa *, - o +.

  - Elemento 1
  - Elemento 2
    - Subelemento
  

• Lista Ordenada: Usa números seguidos de un punto.

  1. Primer elemento
  2. Segundo elemento
  

• Lista de Tareas (GFM):

  - [x] Tarea completada
  - [ ] Tarea incompleta
  

---

3. Enlaces e Imágenes

• Enlace: [Texto](URL) -> Google
• Imagen: ![Texto alternativo](URL)
• Enlace con Título: [Texto](URL "Título")

---

4. Bloques de Código

• Código en línea: Usa comillas simples invertidas: `código`.
• Bloque de Código: Usa comillas triples invertidas con resaltado de lenguaje opcional:

  ```javascript
  console.log("¡Hola, mundo!");
  

---

5. Tablas y Sintaxis Avanzada

Tablas:

| Encabezado 1 | Encabezado 2 |
| :--- | :--- |
| Celda 1 | Celda 2 |
| Celda 3 | Celda 4 |

Notas al pie:

Aquí hay una referencia de nota al pie[^1].
[^1]: Este es el contenido de la nota al pie.

---

6. Sabores de Markdown

• CommonMark: La versión estándar y altamente compatible de Markdown.
• GitHub Flavored Markdown (GFM): Añade soporte para tablas, listas de tareas, tachado y enlaces automáticos. La mayoría de los renderizadores modernos soportan GFM.
• HTML en Markdown: Puedes usar etiquetas HTML puras (como <u> o <div>) dentro de Markdown para diseños más complejos, aunque algunos renderizadores pueden eliminarlas por seguridad.

---

Preguntas Comunes (FAQ)

P: ¿Cómo puedo previsualizar mi Markdown?

R: La mayoría de los editores de código como VS Code tienen una Vista Previa de Markdown integrada (Ctrl+Shift+V). También puedes usar renderizadores de Markdown en línea o editores especializados para ver cómo se verá tu documento después de ser convertido a HTML.

P: ¿Cuál es la diferencia entre un editor de Markdown y un renderizador?

R: Un editor es donde escribes la sintaxis de texto plano. Un renderizador (o analizador) es el motor que convierte esa sintaxis en HTML para su visualización en un navegador.

P: ¿Cuáles son las mejores prácticas para escribir Markdown?

R:

1. Consistencia: Mantén un solo estilo para listas (- vs *) y encabezados.
2. Legibilidad: Usa líneas en blanco entre párrafos y elementos de lista.
3. Texto Alternativo: Proporciona siempre un texto alternativo significativo para las imágenes por accesibilidad.
4. Delimitación de Código: Especifica siempre el lenguaje para los bloques de código para habilitar el resaltado de sintaxis.

---

Relacionado en Tool3M

• Markdown a HTML: Convierte y previsualiza instantáneamente tu Markdown en un HTML limpio y listo para producción.
• Formateador SQL: Formatea bloques de código SQL para pegarlos en tu documentación Markdown.