Skip to main content
·7 min de lectura

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

Compartir:𝕏LinkedIn

Sabias que más de 10 millones de repositorios en GitHub usan Markdown para su documentacion? Desde archivos README hasta bases de conocimiento completas, Markdown se ha convertido silenciosamente en el lenguaje universal de la escritura tecnica. Si aun no lo usas, estas dedicando más tiempo al formato del necesario.

Que es Markdown y por que deberias aprenderlo

Markdown es un lenguaje de marcado ligero creado por John Gruber en 2004. Su proposito es sencillo: permitirte escribir texto con formato usando caracteres simples que son faciles de leer incluso antes de convertirse en HTML. A diferencia de los editores de texto enriquecido donde el formato esta oculto detras de botones en una barra de herramientas, Markdown mantiene todo visible en el archivo fuente. Un solo simbolo de almohadilla crea un encabezado. Un asterisco envuelve una palabra en enfasis. Dos asteriscos la ponen en negrita. La sintaxis es intencionalmente minima 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 documentacion de software, archivos README, wikis, generadores de sitios estaticos, 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, podras escribir documentacion, publicaciones de blog, especificaciones tecnicas y notas personales sin tocar el raton. 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 logicas. Markdown soporta seis niveles de encabezados usando el simbolo 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 pequeno, 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 asi sucesivamente hasta ###### Encabezado 6. En la mayoria de la documentacion usaras principalmente los niveles dos y tres porque el titulo de la página ya ocupa el nivel uno. Una jerarquia de encabezados consistente mejora tanto la legibilidad como la accesibilidad para lectores de pantalla.

Negrita, cursiva y formato en linea

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. Combinalos 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 codigo en linea se marca con acentos graves: `variable` se muestra con fuente monoespaciada, perfecto para referenciar codigo dentro de una oracion.

Enlaces e imágenes

Los enlaces siguen el patron [texto del enlace](URL). Por ejemplo, [OpenAI](https://openai.com) crea un hipervinculo clickeable. Puedes agregar un titulo opcional que aparece al pasar el cursor colocandolo entre comillas despues 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 parrafos limpios: [texto][ref] junto con [ref]: https://ejemplo.com en su propia linea.

Las imágenes usan la misma sintaxis que los enlaces pero con un signo de exclamacion al inicio: ![texto alternativo](imagen-url.png). El texto alternativo dentro de los corchetes describe la imagen para propositos de accesibilidad y aparece cuando la imagen no se puede cargar. Tambien puedes usar imágenes estilo referencia para documentos fuente más limpios. Aunque el Markdown estandar 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 numero seguido de un punto y un espacio: 1. Primer elemento, 2. Segundo elemento, 3. Tercer elemento. Los numeros reales no importan en la mayoria de los renderizadores; podrias escribir 1. en cada linea y la salida seguiria numerandose secuencialmente. Sin embargo, empezar desde uno e ir incrementando se considera buena practica 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 utiles para esquemas, desgloses de funcionalidades y datos jerarquicos. Manten el anidamiento en un maximo de tres niveles para preservar la legibilidad.

Bloques de codigo y codigo en linea

El codigo en linea usa un acento grave a cada lado: `console.log("hola")`. Para bloques de codigo de multiples lineas, envuelve tu codigo con triple acento grave en sus propias lineas. Puedes especificar un identificador de lenguaje inmediatamente despues 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 codigo preservan los espacios en blanco y los saltos de linea exactamente como se escribieron. Esto los hace ideales para compartir archivos de configuracion, comandos de terminal, respuestas de API y fragmentos de codigo. Si tu codigo contiene triple acento grave, puedes usar cuatro acentos graves como cerca para evitar conflictos. Algunas plataformas tambien soportan bloques de codigo indentados donde cada linea esta precedida por cuatro espacios, pero los bloques de codigo cercados con triple acento grave son el estandar moderno y deben preferirse.

Al compartir ejemplos de codigo en documentacion, considera combinar los bloques de codigo Markdown con nuestras Herramientas de Texto para formatear rapidamente, limpiar espacios en blanco o transformar tus fragmentos antes de pegarlos. Si necesitas comparar dos versiones de un bloque de codigo, nuestra guia de diff de texto explica como identificar cambios linea por linea.

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 alineacion con guiones, y las filas siguientes contienen datos. Este es el patron de sintaxis: | Encabezado 1 | Encabezado 2 | en la primera linea, | --- | --- | en la segunda linea, y | Celda 1 | Celda 2 | en las lineas 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 alineacion 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 facil de leer. La mayoria de los editores con soporte Markdown incluyen funciones de formateo de tablas. Las tablas son excelentes para graficos de comparacion, documentacion de parametros de API, matrices de caracteristicas 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 estandar con casillas de verificacion. 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 planificacion 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 codigo fuente del Markdown.

Citas y lineas horizontales

Las citas usan el simbolo mayor que al inicio de una linea: > Esto es una cita. Puedes anidar citas agregando simbolos mayor que adicionales: >> Cita anidada. Las citas se usan comunmente para destacar notas importantes, citar fuentes externas o senalar advertencias en la documentacion. Muchas plataformas de documentacion como GitHub tambien soportan admoniciones especiales de citas con los prefijos > [!NOTE], > [!WARNING] y > [!TIP].

Las lineas horizontales crean un divisor visual entre secciones. Escribe tres o más guiones ---, asteriscos *** o guiones bajos ___ en una linea en blanco. Las lineas horizontales son utiles para separar temas distintos dentro de un solo documento, marcar transiciones o crear pausas visuales en articulos largos. Usalas con moderacion; 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 caracter 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 multiples estilos. Puedes poner texto en negrita dentro de un elemento de lista, agregar codigo en linea dentro de un enlace como [`codigo`](url), o incluir enlaces dentro de citas. Tambien 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 mayoria de los renderizadores pasaran el HTML sin cambios, aunque algunos lo sanitizan por razones de seguridad.

Donde 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 estaticos como Jekyll, Hugo, Gatsby, Astro y Next.js usan Markdown o MDX para publicaciones de blog y páginas de documentacion. Las aplicaciones de notas como Obsidian, Notion, Bear y Typora usan Markdown como su formato de escritura principal. Las plataformas de comunicacion como Slack, Discord y Microsoft Teams soportan subconjuntos de Markdown para formatear mensajes. Las plataformas de documentacion como ReadTheDocs, Docusaurus y GitBook estan construidas completamente alrededor de archivos Markdown.

Mas alla del software, Markdown es cada vez más utilizado por academicos para escribir articulos 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 sera legible en cualquier editor de texto dentro de decadas. 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 tambien se combina naturalmente con otras herramientas de desarrollo. Usa nuestra guia de herramientas de texto para desarrolladores para descubrir utilidades de conversion de mayusculas, conteo de palabras y manipulacion 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

Aqui tienes algunos consejos practicos para acelerar tu escritura en Markdown:

  • Aprende los atajos de teclado: La mayoria 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 linea y lineas 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

Opciones de pago útiles si necesitas soporte, funciones avanzadas o flujos más completos que los de la herramienta gratuita.

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.

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