Las citas en Markdown permiten resaltar fragmentos de texto, comentarios, referencias o notas, utilizando un estilo diferenciado. Se inspiran en el formato de las citas de correo electrónico, donde se usa el símbolo > al inicio de las líneas citadas.
La sintaxis básica para crear una cita es anteponer el símbolo > al inicio de la línea.
Ejemplo simple:
> Esta es una cita en Markdown.
Renderizado:
Esta es una cita en Markdown.
👉 Se puede aplicar a una sola línea o a párrafos completos.
Ejemplo con párrafo largo:
> Markdown es un lenguaje de marcado ligero creado por John Gruber en 2004.
> Su objetivo principal es que el texto sea legible como texto plano, pero pueda convertirse fácilmente a HTML.
Renderizado:
Markdown es un lenguaje de marcado ligero creado por John Gruber en 2004.
Su objetivo principal es que el texto sea legible como texto plano, pero pueda convertirse fácilmente a HTML.
Se pueden crear citas dentro de citas (anidadas) agregando más símbolos > en cada nivel.
Ejemplo:
> Esta es una cita principal.
>> Esta es una cita dentro de otra.
>>> Incluso podemos anidar un tercer nivel.
Renderizado:
Esta es una cita principal.
Esta es una cita dentro de otra.
Incluso podemos anidar un tercer nivel.
👉 Aunque Markdown permite múltiples niveles de anidación, en la práctica rara vez se usan más de 2 porque pierde legibilidad.
Dentro de una cita también se pueden incluir texto con formato, listas, imágenes o enlaces.
Ejemplo:
> ### Nota importante
> - Este texto está en **negrita**.
> - También puede tener *cursiva*.
> - Y un [enlace](https://www.markdownguide.org).
Renderizado:
Nota importante
- Este texto está en negrita.
- También puede tener cursiva.
- Y un enlace.
👉 Esto es muy útil para documentar instrucciones o advertencias en proyectos.
Las citas en Markdown tienen múltiples usos:
Para resaltar advertencias o recordatorios.
Ejemplo:
> **Atención**: Antes de instalar, asegurate de tener Python 3.10 o superior.
Renderizado:
Atención: Antes de instalar, asegurate de tener Python 3.10 o superior.
Para agregar comentarios, ejemplos o recordatorios en un documento personal.
> Nota: Esta fórmula se usa solo en casos especiales.
Renderizado:
Nota: Esta fórmula se usa solo en casos especiales.
Para resaltar frases de autores o fuentes externas.
> El buen diseño es obvio. El gran diseño es transparente. Joe Sparano
Renderizado:
El buen diseño es obvio. El gran diseño es transparente. Joe Sparano
En GitHub, foros o chats que usan Markdown, las citas sirven para responder a un comentario anterior.
Ejemplo en GitHub Issues:
> ¿Podemos usar esta función en producción?
Sí, ya está probada en staging.
Renderizado:
¿Podemos usar esta función en producción?
Sí, ya está probada en staging.
# Ejemplo de citas en Markdown
## Cita simple
> Markdown es fácil de aprender.
## Cita anidada
> Primera idea.
>> Segunda idea dentro de la cita.
## Cita con formato
> ### Advertencia
> - Este comando borra todos los datos.
> - úsalo con **precaución**.
## Cita de autor
> La simplicidad es la máxima sofisticación. Leonardo da Vinci
Renderizado:
Markdown es fácil de aprender.
Primera idea.Segunda idea dentro de la cita.
Advertencia
- Este comando borra todos los datos.
- úsalo con precaución.
La simplicidad es la máxima sofisticación. Leonardo da Vinci
Las citas en Markdown se crean con >, y se pueden anidar con >>, >>>, etc. Sirven para resaltar texto, agregar notas, incluir advertencias o citar a otros autores. Se pueden combinar con otros elementos (listas, enlaces, títulos). Bien usadas, mejoran la legibilidad y la organización de la documentación.
¿Listo para practicar lo aprendido? Visita el visor de Markdown y pon en práctica los conceptos.