Skip to main content
ToolsFree.io🇬🇧en
Por Equipo Editorial de ToolsFree··7 min de lectura

Guía de Markdown para Principiantes: Escribe Mejor Documentación

Compartir:𝕏LinkedIn

Escribe **Empezar** y obtienes Empezar. Escribe # Bienvenido y obtienes un encabezado. Esa es toda la idea detrás de Markdown: un puñado de caracteres simples que se convierten en texto con formato, sin barra de herramientas. Una vez que esos pequeños patrones encajan, puedes escribir un README pulido, una publicación de blog o un conjunto de notas sin levantar las manos del teclado.

¿Qué es Markdown y por qué deberías aprenderlo?

Markdown es un lenguaje de marcado ligero creado por John Gruber en 2004. Su propósito es sencillo: permitirte escribir texto con formato usando caracteres simples que son fáciles de leer incluso antes de convertirse en HTML. A diferencia de los editores de texto enriquecido donde el formato está oculto detrás de botones en una barra de herramientas, Markdown mantiene todo visible en el archivo fuente. Un solo símbolo de almohadilla crea un encabezado. Un asterisco envuelve una palabra en énfasis. Dos asteriscos la ponen en negrita. La sintaxis es intencionalmente mínima para que los escritores puedan concentrarse en el contenido en lugar de luchar con herramientas de formato.

Markdown se ha convertido en el formato de escritura predeterminado para documentación de software, archivos README, wikis, generadores de sitios estáticos, aplicaciones de notas, foros y plataformas de blogs. GitHub, GitLab, Bitbucket, Stack Overflow, Reddit, Discord, Notion, Obsidian y miles de otras plataformas soportan Markdown de forma nativa. Aprender Markdown es una de las habilidades con mayor retorno que puedes adquirir porque la sintaxis funciona igual en todas partes. Una vez que la domines, podrás escribir documentación, publicaciones de blog, especificaciones técnicas y notas personales sin tocar el ratón. Prueba tu sintaxis en tiempo real con nuestro editor de Markdown, que muestra una vista previa en vivo mientras escribes.

Encabezados

Los encabezados estructuran tu documento en secciones lógicas. Markdown soporta seis niveles de encabezados usando el símbolo de almohadilla. La cantidad de almohadillas determina el nivel. Una almohadilla es el encabezado más grande, equivalente a un h1 en HTML, y seis almohadillas producen el encabezado más pequeño, equivalente a h6. Siempre deja un espacio entre la almohadilla y el texto del encabezado.

Ejemplo de sintaxis: # Encabezado 1, ## Encabezado 2, ### Encabezado 3, y así sucesivamente hasta ###### Encabezado 6. En la mayoría de la documentación usarás principalmente los niveles dos y tres porque el título de la página ya ocupa el nivel uno. Una jerarquía de encabezados consistente mejora tanto la legibilidad como la accesibilidad para lectores de pantalla.

Negrita, cursiva y formato en línea

Enfatizar texto en Markdown es intuitivo. Rodea una palabra o frase con asteriscos simples o guiones bajos para cursiva: *cursiva* o _cursiva_ se muestra como cursiva. Usa doble asterisco o doble guion bajo para negrita: **negrita** o __negrita__ se muestra como negrita. Combínalos para negrita cursiva: ***negrita cursiva*** se muestra como negrita cursiva. Para texto tachado, envuelve el contenido con doble virgulilla: ~~eliminado~~ se muestra como eliminado. El código en línea se marca con acentos graves: `variable` se muestra con fuente monoespaciada, perfecto para referenciar código dentro de una oración.

fuenteresultado## Título**negrita**`código`Títulonegritacódigo
Los caracteres simples de Markdown a la izquierda se convierten en texto con formato a la derecha.

Enlaces e imágenes

Los enlaces siguen el patrón [texto del enlace](URL). Por ejemplo, [OpenAI](https://openai.com) crea un hipervínculo clickeable. Puedes agregar un título opcional que aparece al pasar el cursor colocándolo entre comillas después de la URL: [OpenAI](https://openai.com "Visitar OpenAI"). Los enlaces estilo referencia te permiten definir la URL en otra parte del documento, manteniendo tus párrafos limpios: [texto][ref] junto con [ref]: https://ejemplo.com en su propia línea.

Las imágenes usan la misma sintaxis que los enlaces pero con un signo de exclamación al inicio: ![texto alternativo](imagen-url.png). El texto alternativo dentro de los corchetes describe la imagen para propósitos de accesibilidad y aparece cuando la imagen no se puede cargar. También puedes usar imágenes estilo referencia para documentos fuente más limpios. Aunque el Markdown estándar no soporta dimensionamiento de imágenes, muchas plataformas extienden la sintaxis con atributos HTML o directivas personalizadas para controlar el ancho y alto.

Listas: ordenadas, no ordenadas y anidadas

Las listas no ordenadas usan un guion, asterisco o signo más seguido de un espacio antes de cada elemento. Por ejemplo: - Primer elemento, - Segundo elemento, - Tercer elemento. Las listas ordenadas usan un número seguido de un punto y un espacio: 1. Primer elemento, 2. Segundo elemento, 3. Tercer elemento. Los números reales no importan en la mayoría de los renderizadores; podrías escribir 1. en cada línea y la salida seguiría numerándose secuencialmente. Sin embargo, empezar desde uno e ir incrementando se considera buena práctica para la legibilidad.

Anidar listas es sencillo. Indenta el elemento hijo con dos o cuatro espacios (dependiendo del parser) debajo del elemento padre. Puedes anidar listas no ordenadas dentro de listas ordenadas y viceversa. Las listas anidadas son especialmente útiles para esquemas, desgloses de funcionalidades y datos jerárquicos. Mantén el anidamiento en un máximo de tres niveles para preservar la legibilidad.

Bloques de código y código en línea

El código en línea usa un acento grave a cada lado: `console.log("hola")`. Para bloques de código de múltiples líneas, envuelve tu código con triple acento grave en sus propias líneas. Puedes especificar un identificador de lenguaje inmediatamente después de los acentos graves de apertura para activar el resaltado de sintaxis. Por ejemplo, escribir tres acentos graves seguidos de js le indica al renderizador que resalte el bloque como JavaScript. Los identificadores de lenguaje comunes incluyen js, ts, python, html, css, bash, json y sql.

Los bloques de código preservan los espacios en blanco y los saltos de línea exactamente como se escribieron. Esto los hace ideales para compartir archivos de configuración, comandos de terminal, respuestas de API y fragmentos de código. Si tu código contiene triple acento grave, puedes usar cuatro acentos graves como cerca para evitar conflictos. Algunas plataformas también soportan bloques de código indentados donde cada línea está precedida por cuatro espacios, pero los bloques de código cercados con triple acento grave son el estándar moderno y deben preferirse.

Al compartir ejemplos de código en documentación, considera combinar los bloques de código Markdown con nuestras Herramientas de Texto para formatear rápidamente, limpiar espacios en blanco o transformar tus fragmentos antes de pegarlos. Si necesitas comparar dos versiones de un bloque de código, nuestra guía de diff de texto explica cómo identificar cambios línea por línea.

Tablas

Las tablas en Markdown usan barras verticales y guiones para definir columnas y filas. La primera fila es el encabezado, la segunda fila define la alineación con guiones, y las filas siguientes contienen datos. Este es el patrón de sintaxis: | Encabezado 1 | Encabezado 2 | en la primera línea, | --- | --- | en la segunda línea, y | Celda 1 | Celda 2 | en las líneas de datos. Puedes alinear las columnas a la izquierda, al centro o a la derecha colocando dos puntos en la fila separadora: :--- para izquierda, :---: para centro y ---: para alineación derecha.

Las tablas no necesitan estar visualmente alineadas en el documento fuente, pero alinear las barras verticales hace que el Markdown sin procesar sea mucho más fácil de leer. La mayoría de los editores con soporte Markdown incluyen funciones de formateo de tablas. Las tablas son excelentes para gráficos de comparación, documentación de parámetros de API, matrices de características y cualquier dato que se ajuste naturalmente a una estructura de filas y columnas. Para tablas muy complejas con celdas fusionadas o contenido anidado, puedes recurrir a HTML puro dentro de tu documento Markdown.

Listas de tareas

Las listas de tareas extienden las listas estándar con casillas de verificación. Usa - [ ] para un elemento sin marcar y - [x] para un elemento marcado. Las listas de tareas son compatibles con GitHub, GitLab y muchas otras plataformas. Son perfectas para rastrear elementos pendientes en descripciones de pull requests, plantillas de issues y documentos de planificación de proyectos. En GitHub, las listas de tareas en el cuerpo de los issues incluso se renderizan como casillas interactivas que los colaboradores pueden marcar sin editar el código fuente del Markdown.

Citas y líneas horizontales

Las citas usan el símbolo mayor que al inicio de una línea: > Esto es una cita. Puedes anidar citas agregando símbolos mayor que adicionales: >> Cita anidada. Las citas se usan comúnmente para destacar notas importantes, citar fuentes externas o señalar advertencias en la documentación. Muchas plataformas de documentación como GitHub también soportan admoniciones especiales de citas con los prefijos > [!NOTE], > [!WARNING] y > [!TIP].

Las líneas horizontales crean un divisor visual entre secciones. Escribe tres o más guiones ---, asteriscos *** o guiones bajos ___ en una línea en blanco. Las líneas horizontales son útiles para separar temas distintos dentro de un solo documento, marcar transiciones o crear pausas visuales en artículos largos. Úsalas con moderación; los encabezados suelen ser una mejor forma de organizar el contenido.

Consejos avanzados: escape y formato anidado

Dado que Markdown asigna significados especiales a caracteres como asteriscos, almohadillas, acentos graves, corchetes y barras verticales, a veces necesitas mostrar estos caracteres de forma literal. Precede cualquier carácter especial con una barra invertida para escaparlo: \*no cursiva\* se muestra como *no cursiva* en lugar de texto enfatizado. Esto funciona para todos los caracteres especiales de Markdown, incluyendo las propias barras invertidas.

El formato anidado te permite combinar múltiples estilos. Puedes poner texto en negrita dentro de un elemento de lista, agregar código en línea dentro de un enlace como [`código`](url), o incluir enlaces dentro de citas. También puedes incrustar HTML puro en cualquier parte de un documento Markdown para funcionalidades que la sintaxis no cubre de forma nativa, como widgets de detalle y resumen, listas de definiciones o contenedores con estilos personalizados. La mayoría de los renderizadores pasarán el HTML sin cambios, aunque algunos lo sanitizan por razones de seguridad.

Dónde se usa Markdown

Markdown ha sido adoptado en una gama extraordinaria de plataformas. GitHub y GitLab lo usan para archivos README, issues, descripciones de pull requests, comentarios, wikis y GitHub Pages. Los generadores de sitios estáticos como Jekyll, Hugo, Gatsby, Astro y Next.js usan Markdown o MDX para publicaciones de blog y páginas de documentación. Las aplicaciones de notas como Obsidian, Notion, Bear y Typora usan Markdown como su formato de escritura principal. Las plataformas de comunicación como Slack, Discord y Microsoft Teams soportan subconjuntos de Markdown para formatear mensajes. Las plataformas de documentación como ReadTheDocs, Docusaurus y GitBook están construidas completamente alrededor de archivos Markdown.

Más allá del software, Markdown es cada vez más utilizado por académicos para escribir artículos con Pandoc, por autores para redactar manuscritos y por equipos de contenido para gestionar flujos de trabajo editoriales. Su simplicidad, portabilidad y naturaleza de texto plano garantizan que tu contenido nunca quede atrapado en un formato propietario. Un archivo Markdown escrito hoy será legible en cualquier editor de texto dentro de décadas. Comienza a practicar con nuestro editor de Markdown y experimenta lo rápido que puedes producir documentos limpios y bien formateados usando solo tu teclado.

Markdown también se combina naturalmente con otras herramientas de desarrollo. Usa nuestra guía de herramientas de texto para desarrolladores para descubrir utilidades de conversión de mayúsculas, conteo de palabras y manipulación de cadenas que complementan tu flujo de trabajo con Markdown. Al colaborar en documentos Markdown, una herramienta de diff de texto te ayuda a comparar revisiones y detectar cada cambio entre borradores.

Consejos de productividad con Markdown

Aquí tienes algunos consejos prácticos para acelerar tu escritura en Markdown:

  • Aprende los atajos de teclado: La mayoría de los editores de Markdown soportan atajos como Ctrl+B para negrita, Ctrl+I para cursiva y Ctrl+K para enlaces. Memorizarlos ahorra mucho tiempo.
  • Usa un linter: Herramientas como markdownlint detectan problemas comunes de formato como niveles de encabezado inconsistentes, espacios al final de línea y líneas en blanco faltantes alrededor de los encabezados.
  • Previsualiza antes de publicar: Siempre previsualiza tu Markdown antes de hacer commit o publicar. Nuestro editor de Markdown muestra una vista previa en vivo junto a tu texto fuente.

Herramientas de Escritura Profesional

Cuando escribes más que una nota rápida, estas son las herramientas que usamos. Cada una se apoya en Markdown: pulir el texto, enlazar notas o darte un editor sin distracciones.

Podemos recibir una comisión a través de enlaces de afiliados sin coste adicional para ti.

Priorizamos herramientas que encajan con el caso de uso; no todas las recomendaciones dependen de acuerdos de afiliacion.

Artículos relacionados

Aprende más con nuestras guías detalladas y tutoriales relacionados.

Guía de Markdown para Principiantes: Escribe Mejor Documentación | ToolsFree.io