Hinzufügen von Farbe zu Github's README.md Datei

Ich habe eine README.md-Datei für mein Projekt underscore-cli, ein ziemlich süßes Tool zum Hacken von JSON und JS auf der Kommandozeile.

Ich möchte das "--color" Flag dokumentieren ... welches ... Dinge einfärbt. Das würde viel besser gehen, wenn ich tatsächlich zeigen könnte, wie die Ausgabe aussieht. Ich kann anscheinend keine Möglichkeit finden, Farbe in meine README.md einzufügen. Irgendwelche Ideen?

Ich habe dies versucht:

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

Und dies:

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

Bis jetzt kein Glück.

Prateek Gupta
Bearbeitete Frage 8. Oktober 2019 в 8:20
Programmierung
markdown github colors github-pages readme
16. Juli 2012 в 5:55
7 Aufrufe

Sie können einfachen Text in einer GitHub-"README.md"-Datei nicht einfärben. Sie können jedoch Codebeispielen 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 zum Einfärben
```
```html
   // Code für die Einfärbung
```
```js
   // Code für die Einfärbung
```
```css
   // Code für die Einfärbung
```
// usw.
// usw;

Keine "pre" oder "code" Tags erforderlich.


Dies wird in der GitHub Markdown Dokumentation behandelt (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 deren Markdown-Schlüsselwörter) finden Sie in der Linguist's YAML-Datei.
totallytotallyamazing
Bearbeitete Antwort 10. April 2017 в 6:03
Kommentare (12)

Leider ist dies derzeit nicht möglich.

In der GitHub Markdown-Dokumentation werden 'color', 'css', 'html', oder 'style' nicht erwähnt.

Während einige Markdown-Prozessoren (z.B. der in Ghost verwendete) HTML zulassen, wie z.B. <span style="color:orange;">Word up</span>, verwirft der von GitHub's jegliches HTML.

Wenn Sie unbedingt Farbe in Ihrer Readme-Datei verwenden wollen, kann Ihre README.md die Benutzer einfach auf eine README.html verweisen. Der Kompromiss dafür ist natürlich die Zugänglichkeit.

M-Pixel
Bearbeitete Antwort 18. Juni 2014 в 5:27
Kommentare (3)

Ich bin geneigt, mit Qwertman übereinzustimmen, dass es derzeit nicht möglich ist, Farbe für Text in GitHub Markdown, zumindest nicht durch HTML angeben.

GitHub erlaubt zwar einige HTML-Elemente und -Attribute, aber nur bestimmte (siehe die Dokumentation über die HTML-Sanitization). Sie erlauben die Tags "p" und "div" sowie das Attribut "color". Als ich jedoch versuchte, sie in einem Markdown-Dokument auf GitHub zu verwenden, funktionierte es nicht. Ich habe folgendes ausprobiert (neben anderen Varianten), und es hat nicht funktioniert:

  • <p style='color:red'>This is some red text.</p>
  • This is some text!
  • Dies sind rote Wörter.

Wie Qwertman vorschlug, könnten Sie, wenn Sie wirklich Farbe verwenden müssen, dies in einer README.html tun und auf diese verweisen.

Kommentare (2)