YamlBox

Web y codificación · 5 minutos de lectura

Markdown tablas: generarlas en lugar de contar tuberías

Una tabla de rebajas es una cuadrícula de celdas escritas con barras verticales y guiones, y es la única parte de las rebajas que es realmente desagradable de escribir a mano. Contar tuberías, mantener la fila delimitadora del mismo ancho que el encabezado y escapar de una tubería que aparece dentro de una celda compiten por la atención. Generar la tabla elimina los tres problemas a la vez.

Actualizado

La sintaxis, en un ejemplo.

                | Tool          | Input       | Offline |
| :------------ | :---------: | ------: |
| YAML to JSON  | YAML        | yes     |
| JWT decoder   | JWT         | yes     |
              

La primera fila es el encabezado, la segunda es la fila delimitadora y todo lo que sigue son datos. Los dos puntos en la fila delimitadora establecen la alineación: `:---` izquierda, `:---:` centro, `---:` derecha. GitHub y la mayoría de los renderizadores aceptan una tubería inicial y final como opcional, pero incluirlas mantiene el texto sin formato legible en un editor.

Las tres cosas que rompen las mesas

  • Una tubería dentro de una celda: escape como `\|`, o la fila se dividirá en una columna de más.
  • Una fila delimitadora con un número incorrecto de columnas: el encabezado se desplaza y la tabla queda desalineada.
  • Una línea en blanco dentro de la tabla: el renderizador la trata como el final de la tabla e imprime el resto como texto.

Escapar es lo más importante para el código y las expresiones regulares en las celdas: `a|b` y `\bfoo\b` necesitan atención antes de poder vivir felices dentro de una mesa.

Obtener datos de una hoja de cálculo

El flujo de trabajo natural es pegar una selección de una hoja de cálculo o una exportación CSV y dejar que el generador haga las citas y la alineación. Esto es más rápido y menos propenso a errores que escribir filas, y también maneja los casos aburridos: anchos de columna variables, números que deben estar alineados a la derecha, celdas que contienen comas. Recorte las columnas vacías finales antes de pegarlas para evitar una tabla con columnas fantasmas que se muestren como espacios en blanco.

Cuando no usar una mesa

Las tablas sirven para realizar comparaciones: matrices de características, referencias de indicadores, listas de compatibilidad, variables de entorno. Son malos para la prosa, malos para descripciones largas y dolorosos en pantallas estrechas porque Markdown no tiene un comportamiento de respuesta: el renderizador se desplaza horizontalmente o comprime las columnas en fragmentos ilegibles. Si una celda necesita un párrafo, utilice una lista de definiciones, un encabezado por entrada o una lista con viñetas. Una tabla que nadie puede leer en un teléfono es peor que la lista que reemplazó.

Generar y luego pegar en cualquier lugar

El resultado es un simple descuento, por lo que cae directamente en un archivo README, una descripción de solicitud de extracción, una página wiki, un ticket de Jira o un comentario. El generador de tablas de rebajas YamlBox se ejecuta en el navegador, alinea las columnas, escapa de las canalizaciones y sigue trabajando sin conexión, para que pueda pegar datos internos sin publicarlos en ningún lugar.

Markdown Generador de tablas — preguntas frecuentes

¿Cómo coloco un carácter de barra vertical dentro de una celda de una tabla de rebajas?

Escápelo con una barra invertida (`\|`); de lo contrario, el renderizador lo trata como el final de la celda. Los generadores manejan esto automáticamente, que es la razón principal para construir tablas con una herramienta en lugar de hacerlo a mano.

¿Cómo alineo una columna en Markdown?

Utilice dos puntos en la fila delimitadora: `:---` para la izquierda, `:---:` para el centro y `---:` para la derecha. La alineación se aplica a toda la columna, por lo tanto, alinee las columnas numéricas a la derecha y el texto a la izquierda para obtener un resultado más legible.

¿Por qué no se muestra mi tabla de rebajas?

Verifique tres cosas: la fila delimitadora tiene exactamente tantas columnas como el encabezado, no hay ninguna línea en blanco dentro de la tabla y la fila del encabezado precede directamente a la fila delimitadora. Cualquiera de esos tres interrumpirá el renderizado en rebajas con sabor GitHub.

Herramientas mencionadas en esta publicación.

Explore la lista completa de 19 herramientas

Más artículos para leer

Todas las 19 publicaciones →