Cómo añadir color al archivo README.md de Github's
Tengo un archivo README.md para mi proyecto underscore-cli, una herramienta bastante dulce para hackear JSON y JS en la línea de comandos.
Quiero documentar el "--color" bandera ... que ... colores cosas. Eso iría mucho mejor si pudiera mostrar cómo se ve la salida. Parece que no puedo encontrar una manera de añadir color a mi README.md. ¿Alguna idea?
I'he intentado esto:
<span style="color: green"> Some green text </span>Y esto:
<font color="green"> Some green text </font>No ha habido suerte hasta ahora.
271
3
No puedes colorear texto plano en un archivo
README.mdde GitHub. Sin embargo, puedes añadir color a las muestras de código con las etiquetas siguientes.Para ello sólo tienes que añadir etiquetas como estas muestras a tu archivo README.md: pre>
// etc.
No se necesitan etiquetas "pre" ni "code".
Esto está cubierto en la documentación de GitHub Markdown (hacia la mitad de la página, hay'un ejemplo usando Ruby). GitHub utiliza Linguist para identificar y resaltar la sintaxis - puedes encontrar una lista completa de los idiomas soportados (así como sus palabras clave markdown) en Linguist's YAML file.
Desgraciadamente, esto no es posible actualmente.
La documentación GitHub Markdown no menciona 'color', 'css', 'html', o 'style'.
Mientras que algunos procesadores Markdown (por ejemplo, el utilizado en Ghost) permiten HTML, como
<span style="color:naranja;">Word up</span>, GitHub's descarta cualquier HTML.Si es imperativo que uses color en tu readme, tu README.md podría simplemente remitir a los usuarios a un README.html. La contrapartida, por supuesto, es la accesibilidad.
Estoy de acuerdo con Qwertman en que actualmente no es posible especificar el color del texto en GitHub markdown, al menos no a través de HTML.
GitHub permite algunos elementos y atributos HTML, pero sólo algunos (véase su documentación sobre HTML sanitization). Permiten las etiquetas
pydiv, así como el atributocolor. Sin embargo, cuando intenté usarlas en un documento markdown en GitHub, no funcionó. Probé lo siguiente (entre otras variaciones), y no funcionó:<p style='color:red'>This is some red text.</p>¡Esto es algo de texto!Estas son palabras rojas.Como sugirió Qwertman, si realmente debes usar color podrías hacerlo en un README.html y remitirles a él.