Comment append de la couleur au fichier README.md de Github

J’ai un fichier README.md pour mon projet underscore-cli , un outil très intéressant pour pirater JSON et JS sur la ligne de commande.

Je veux documenter le drapeau “–color” … qui … colore les choses. Cela irait beaucoup mieux si je pouvais montrer à quoi ressemble la sortie. Je n’arrive pas à trouver un moyen d’append de la couleur à mon fichier README.md. Des idées?

J’ai essayé ceci:

 Some green text  

Et ça:

  Some green text  

Pas de chance jusqu’à présent.

Il convient de mentionner que vous pouvez append un peu de couleur dans un fichier README en utilisant un service d’impression d’espace réservé. Par exemple, si vous souhaitez fournir une liste de couleurs à titre de référence:

 - ![#f03c15](https://placehold.it/15/f03c15/000000?text=+) `#f03c15` - ![#c5f015](https://placehold.it/15/c5f015/000000?text=+) `#c5f015` - ![#1589F0](https://placehold.it/15/1589F0/000000?text=+) `#1589F0` 

Produit:

  • # f03c15 #f03c15
  • # c5f015 #c5f015
  • # 1589F0 #1589F0

Vous pouvez utiliser la balise de langue diff pour générer du texte en surbrillance vert et rouge:

 ```diff + this will be highlighted in green - this will be highlighted in red ``` 

Vous ne pouvez pas colorer du texte brut dans un fichier GitHub README.md . Vous pouvez cependant append de la couleur aux exemples de code avec les balises ci-dessous.

Pour ce faire, ajoutez simplement des balises telles que ces exemples à votre fichier README.md:

 `` `json
    // code pour la coloration
 `` `
 `` `html
    // code pour la coloration
 `` `
 `` `js
    // code pour la coloration
 `` `
 `` `css
    // code pour la coloration
 `` `
 // etc.

Aucune balise “pre” ou “code” nécessaire.

Ceci est couvert dans la documentation de GitHub Markdown (à peu près à mi-chemin de la page, il y a un exemple d’utilisation de Ruby). GitHub utilise Linguist pour identifier et mettre en évidence la syntaxe – vous pouvez trouver une liste complète des langues sockets en charge (ainsi que leurs mots-clés de démarques) dans le fichier YAML du linguiste .

Malheureusement, ce n’est actuellement pas possible.

La documentation de GitHub Markdown ne mentionne pas «color», «css», «html» ou «style».

Alors que certains processeurs Markdown (par exemple celui utilisé dans Ghost ) autorisent le HTML, tel que Word up , GitHub supprime tout HTML.

S’il est impératif que vous utilisiez la couleur dans votre fichier readme, votre README.md pourrait simplement renvoyer les utilisateurs à un fichier README.html. Le compromis pour cela, bien sûr, est l’accessibilité.

Je suis enclin à être d’accord avec Qwertman sur le fait qu’il n’est actuellement pas possible de spécifier la couleur du texte dans le balise GitHub, du moins pas via HTML.

GitHub autorise certains éléments et atsortingbuts HTML, mais seulement certains (voir leur documentation sur la désinfection HTML ). Ils permettent les balises p et div , ainsi que color atsortingbuts de color . Cependant, lorsque j’ai essayé de les utiliser dans un document de démarquage sur GitHub, cela n’a pas fonctionné. J’ai essayé ce qui suit (parmi d’autres variations), et ils n’ont pas fonctionné:

  • This is some red text.

  • This is some text!
  • These are red words.

Comme Qwertman l’a suggéré, si vous devez vraiment utiliser la couleur, vous pouvez le faire dans un fichier README.html et y faire référence.

Au lieu de rendre une image raster, vous pouvez incorporer un fichier SVG dans le code Markdown en tant que:

  

Le fichier SVG peut alors ressembler à:

    Hello, world!   

Malheureusement, même si vous pouvez sélectionner et copier du texte lorsque vous ouvrez le fichier .svg , le texte ne peut pas être sélectionné lorsque l’image SVG est incorporée.

Voir la démo: https://gist.github.com/CyberShadow/95621a949b07db295000

J’ai ajouté de la couleur à une page de marquage GitHub en utilisant les caractères EnoMode emoji, par exemple 💡 ou 🛑 – certains caractères emoji sont colorés dans certains navigateurs. (Il n’y a pas d’alphabet emoji coloré pour autant que je sache.)