Hinzufügen von Farbe zur README.md-Datei von GitHub

Question

Tengo un README.md Datei für mein Projekt underscore-cli und ich möchte die --color Flagge.

Derzeit ist die nur Dies kann durch einen Screenshot geschehen (der im Projektarchiv gespeichert werden kann):

Screenshots sind jedoch kein Text, so dass die Leser den Befehl im Screenshot nicht kopieren/einfügen können. Außerdem ist es mühsam, sie zu erstellen/zu bearbeiten/zu pflegen, und sie werden von Browsern langsamer geladen. Im modernen Web werden Textstile verwendet, nicht ein Haufen gerenderter Bilder von Text.

Einige Markdown-Parser unterstützen Inline-HTML-Styling, GitHub jedoch nicht; dies funktioniert nicht:

<span style="color: green"> Some green text </span>

Das klappt nicht:

<font color="green"> Some green text </font>

Answer 1

Eine Möglichkeit, einer README Farbe zu geben, besteht darin, einen Dienst zu nutzen, der Platzhalterbilder .

Zum Beispiel kann dieses Markdown verwendet werden:

- ![#f03c15](https://placehold.co/15x15/f03c15/f03c15.png) `#f03c15`
- ![#c5f015](https://placehold.co/15x15/c5f015/c5f015.png) `#c5f015`
- ![#1589F0](https://placehold.co/15x15/1589F0/1589F0.png) `#1589F0`

So erstellen Sie eine Liste mit allen Farben, die Sie mögen:

• #f03c15
• #c5f015
• #1589F0

Answer 2

Sie können die diff Sprache, um farbigen Text zu erzeugen:

```diff
- text in red
+ text in green
! text in orange
# text in gray
@@ text in purple (and bold)@@
```

Er fügt sie jedoch als neue Zeile ein, die entweder mit - + ! # oder beginnt und endet mit @@

Diese Frage wurde angesprochen in GitHub-Auszeichnung #369 aber sie haben seitdem (2014) nichts an der Entscheidung geändert.

Answer 3

Sie können keinen einfachen Text in einem GitHub README.md Datei. Sie können den Codebeispielen jedoch mit den unten stehenden Tags Farbe hinzufügen.

Fügen Sie dazu einfach Tags wie diese Beispiele in Ihre README.md-Datei ein:

\`\`\`json
   // code for coloring
\`\`\`
\`\`\`html
   // code for coloring
\`\`\`
\`\`\`js
   // code for coloring
\`\`\`
\`\`\`css
   // code for coloring
\`\`\`
// etc.

Keine "pre"- oder "code"-Tags erforderlich.

Dies ist Gegenstand der GitHub Markdown-Dokumentation (etwa auf halber Strecke der Seite gibt es ein Beispiel mit Ruby). GitHub verwendet Linguist um die Syntax zu erkennen und hervorzuheben - eine vollständige Liste der unterstützten Sprachen (sowie der zugehörigen Markdown-Schlüsselwörter) finden Sie in der YAML-Datei des Linguisten .

Answer 4

Diese Emoji-Zeichen sind auch nützlich, wenn Sie mit dieser begrenzten Vielfalt an Farben und Formen zurechtkommen (obwohl sie in verschiedenen Betriebssystemen und Browsern unterschiedlich aussehen können). AlecRusts Antwort der einen externen Dienst benötigt, der eines Tages ausfallen könnte, und mit der Idee, Emojis von Luke Hutchison's Antwort :

Es gibt auch viele farbige rechteckige Zeichen mit alphanumerischen, Pfeil- und anderen Symbolen, die für Sie geeignet sein könnten.

---

Beispiel für die Verwendung: Dies war mein Anwendungsfall die durch diese Emojis gelöst wurde (die mir nach dem Lesen der Antworten hier eingefallen sind)

---

Außerdem sind die folgenden Emojis hautfarben Modifikatoren die nur auf einigen Geräten die Hautfarben innerhalb dieser rechteckigen Form haben. Unter Windows zum Beispiel sind sie nicht einmal farbig. Benutzen Sie sie nicht! Sie sollten nicht allein verwendet werden, sondern zusammen mit anderen Emojis, um die Ausgabe ihrer Geschwister-Emojis zu verändern. Außerdem werden sie in verschiedenen Betriebssystemen, Versionen, Browsern und Versionskombinationen sehr unterschiedlich dargestellt, wenn sie allein verwendet werden.

Answer 5

Leider ist dies derzeit nicht möglich.

En GitHub Markdown-Dokumentation enthält keinen Hinweis auf "Farbe", "CSS", "HTML" oder "Stil".

Während einige Markdown-Prozessoren (z. B. der in Geist ) erlauben HTML, wie zum Beispiel <span style="color:orange;">Word up</span> verwirft GitHub jegliches HTML.

Wenn es zwingend erforderlich ist, dass Sie in Ihrer Readme-Datei Farbe verwenden, sollte Ihr README.md Datei könnte die Nutzer einfach auf eine README.html Datei. Der Preis dafür ist natürlich die Zugänglichkeit.