Cómo añadir un banner ASCII a un README de GitHub
Usa un bloque de código, limita las columnas y conserva un título de texto accesible.
Un banner con el nombre del proyecto da personalidad a un README sin añadir una imagen al repositorio. Al ser texto, se puede versionar junto al código, pero necesita conservar espacios y saltos de línea.
Usa un bloque de código
Fuera de un bloque, Markdown puede colapsar espacios o interpretar _ y * como formato. Usa tres acentos graves y el identificador text.
```text
___ _____ __
| \| __\ \ / /
| |) | _| \ V /
|___/|___| \_/
```
# DEV
Una herramienta que puedes ejecutar desde la terminal.
Añade siempre un título de texto normal además del dibujo. Los buscadores y lectores de pantalla no interpretan las letras grandes como un encabezado legible.
Si el propio dibujo contiene tres acentos graves consecutivos, usa un delimitador de cuatro para el bloque Markdown.
Mantén un ancho cómodo
| Lugar de lectura | Ancho orientativo |
|---|---|
| README en ordenador | Hasta unas 80 columnas |
| Pantalla estrecha o móvil | Unas 50 columnas o menos |
| Terminal | Según su ventana; 80 columnas es un punto de partida |
Un banner ancho puede obligar a desplazarse horizontalmente. Escribe el nombre en el convertidor y comprueba el ancho real de cada tarjeta. Para nombres largos, prueba Small o Mini o divide el título en dos partes.
Dentro de un comentario de código
/*
* ___ _____ __
* | \| __\ \ / /
* | |) | _| \ V /
* |___/|___| \_/
*/
export function iniciar() {}
Ten en cuenta el margen que añaden los marcadores de comentario. Si el dibujo contiene */, puede cerrar un comentario de bloque; usa comentarios de línea en ese caso. Respeta el límite de longitud acordado en tu proyecto.
Dentro de una cadena JavaScript
Las barras inversas pueden iniciar escapes. String.raw conserva las barras del dibujo:
const banner = String.raw`
___ _____ __
| \| __\ \ / /
| |) | _| \ V /
|___/|___| \_/
`;
console.log(banner);
El contenido todavía forma parte de una plantilla JavaScript: un acento grave sin escapar puede cerrarla y ${ inicia una interpolación. Si el dibujo contiene esos caracteres, cambia de fuente, escápalos correctamente o guárdalo en un archivo de texto.
En Python puedes usar una cadena sin procesar:
BANNER = r"""
___ _____ __
| \| __\ \ / /
| |) | _| \ V /
|___/|___| \_/
"""
print(BANNER)
Para una herramienta CLI, evita imprimir decoración si la salida va a otro programa o a un archivo. Ofrece una opción como --quiet. La guía de terminales muestra ejemplos de inicio interactivo.
Qué fuente elegir
- Standard: un punto de partida clásico.
- Slant: letras inclinadas con sensación de movimiento.
- Small o Mini: nombres largos y pantallas pequeñas.
- Banner: trazos rellenos con
#. - Digital: cada carácter dentro de una pequeña caja.
Compara las 12 fuentes FIGlet o consulta cómo elegir una fuente. La conversión se hace en el navegador; guarda el TXT si quieres reutilizar el banner sin volver a generarlo.