Formatear Markdown

Cómo funciona

Un README que escriben varias personas, o un archivo de notas que lleva años, termina desordenado: unos puntos empiezan con *, otros con -, las columnas de las tablas ya no coinciden y los títulos quedan pegados a los párrafos. Pegue el texto en el cuadro izquierdo. A la derecha, cada elemento de lista empieza con la viñeta que eligió, los subelementos llevan dos espacios de sangría, los números escritos como 1) pasan a 1. y las tablas se alinean columna por columna. Por ejemplo, una fila |Comando|Descripción| y las filas de abajo se rellenan con espacios hasta la celda más ancha para formar columnas rectas; se conservan marcas de alineación como :- y -:. Entre títulos, párrafos, listas y bloques de código queda una línea en blanco. El interior de los bloques de código (abiertos con ```) nunca se toca y sus saltos de línea dentro de los párrafos quedan donde están. La línea de resultado indica cuántas líneas, elementos de lista y tablas hay, o avisa que el texto ya estaba ordenado.

Esta herramienta también se busca como formatear markdown, markdown formatter, alinear tabla markdown, ordenar markdown, formatear readme, markdown beautifier online.

¿Qué es Markdown?

Markdown da formato a texto plano con unos pocos signos: # crea un título, * o - un elemento de lista, ** negrita y ` código. Los archivos README de GitHub, muchas aplicaciones de notas y sitios de documentación lo usan. Está pensado para leerse también como texto plano; por eso importa que el texto fuente esté ordenado, con tablas alineadas y un solo tipo de viñeta, cuando un equipo trabaja en el mismo archivo.

¿Qué es Tabla de Markdown (GFM)?

Las tablas de Markdown vienen de GitHub Flavored Markdown (GFM): las celdas se separan con |, la fila --- debajo del encabezado define la tabla, y :--, --: y :-: indican si una columna va alineada a la izquierda, a la derecha o al centro. La tabla final no depende del ancho de las celdas en el texto, pero si las columnas no están alineadas en la fuente, cuesta mucho leerla o editarla.

¿Cuál es la diferencia entre formatear Markdown y convertirlo a HTML?

Formatear deja el Markdown como Markdown y solo ordena el texto: una sola viñeta, tablas alineadas, líneas en blanco parejas. El resultado vuelve al mismo README. Convertir a HTML transforma el Markdown en código de página web: un título con # pasa a ser una etiqueta <h1>, un elemento de lista pasa a <li>, y el resultado va a una página web o a un correo. Esta página hace lo primero; para lo segundo use la herramienta de Markdown a HTML.

¿Dar formato cambia cómo se ve el Markdown?

No. GitHub, GitLab o una aplicación de notas ignoran los espacios de más y el tipo de viñeta al convertir el Markdown en HTML; el texto ordenado produce la misma página. Lo que mejora es la lectura del texto sin procesar: la tabla se puede leer como texto, los cambios de distintas personas se ven iguales y las diferencias en el control de versiones son más pequeñas.

Un detalle: según las reglas de Markdown, líneas seguidas que empiezan con viñetas distintas (* y +) son dos listas separadas. La herramienta las mantiene separadas y escribe la segunda con la otra viñeta. Si quiere una sola lista, escriba todos sus elementos con la misma viñeta.

¿Guion o asterisco?

Los dos son válidos y se ven igual. La documentación de GitHub, Prettier y la mayoría de los proyectos de código abierto usan el guion (-); el asterisco (*) es común en documentos antiguos y algunas aplicaciones de notas. Elija el que ya predomina en su proyecto; lo importante es que el archivo sea uniforme.

Cuando dos listas separadas van seguidas, la herramienta escribe la segunda con la otra viñeta para que Markdown no las junte. Las listas numeradas usan número y punto (1.); la forma 1) también se convierte.

• README de GitHub, proyecto de código abierto → - guion
• Seguir documentos antiguos o la costumbre del equipo → * asterisco
• Pasos numerados → 1. 2. 3. (la herramienta los corrige)

Preguntas frecuentes

¿Cómo alineo una tabla de Markdown?

Pegue la tabla en el cuadro izquierdo de esta página. Cada columna se rellena hasta su celda más ancha, la fila separadora se ensancha igual y se conservan las marcas de alineación (:--, --:, :-:). El contenido de las celdas no cambia.

¿La herramienta cambia lo que hay dentro de mis bloques de código?

No. Cada carácter dentro de un bloque abierto con ``` o ~~~ queda igual; solo se agrega una línea en blanco antes y después del bloque.

¿Se unen o se cortan las líneas de mis párrafos?

No. Los saltos de línea dentro de los párrafos se conservan; la herramienta no corta las líneas largas ni une las cortas.

¿Mi texto se envía a un servidor?

No. El formato se aplica por completo en su navegador; el texto que pega no sale de esta página y no se guarda en ningún lugar.