Github'ın README.md dosyasına nasıl renk eklenir

Projem için bir README.md dosyam var underscore-cli, komut satırında JSON ve JS'yi kesmek için oldukça tatlı bir araç.

Bir şeyleri renklendiren "--color" bayrağını belgelemek istiyorum. Çıktının neye benzediğini gerçekten gösterebilseydim bu çok daha iyi olurdu. README.md dosyama renk eklemenin bir yolunu bulamıyorum. Fikri olan var mı?

Bunu denedim:

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

Ve bu:

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

Şimdilik bir şey yok.

Prateek Gupta
Edited question 2019ösp20ös20 Ekim 2019 в 8:20
Programlama
markdown github colors github-pages readme
2012ösp55ös17 Temmuz 2012 в 5:55
35 görünümler

Bir GitHub README.md dosyasındaki düz metni renklendiremezsiniz. Ancak aşağıdaki etiketlerle kod örneklerine renk ekleyebilirsiniz.

Bunu yapmak için README.md dosyanıza bu örnekler gibi etiketler eklemeniz yeterlidir:

```json
   // renklendirme için kod
```
```html
   // renklendirme için kod
```
```js
   // renklendirme için kod
```
```css
   // renklendirme için kod
```
// vb.

Hiçbir "pre" veya "code" etiketi gerekmez.

Bu konu GitHub Markdown documentation (sayfanın yaklaşık yarısında Ruby kullanan bir örnek var). GitHub sözdizimini tanımlamak ve vurgulamak için Linguist kullanır - desteklenen dillerin tam listesini (ve markdown anahtar kelimelerini) Linguist's YAML file adresinde bulabilirsiniz.

totallytotallyamazing
Edited answer 2017ösp3ös18 Nisan 2017 в 6:03
Yorumlar (12)

Ne yazık ki, bu şu anda mümkün değildir.

GitHub Markdown belgelerinde](https://help.github.com/articles/github-flavored-markdown) 'color', 'css', 'html' veya 'style' ifadeleri bulunmamaktadır.

Bazı Markdown işlemcileri (örneğin Ghost'da kullanılan) <span style="color:orange;">Word up</span> gibi HTML'ye izin verirken, GitHub'ınki tüm HTML'leri atar.

Eğer readme'nizde renk kullanmanız zorunluysa, README.md dosyanız kullanıcıları README.html dosyasına yönlendirebilir. Elbette bunun karşılığı erişilebilirliktir.

M-Pixel
Edited answer 2014ösp27ös17 Haziran 2014 в 5:27
Yorumlar (3)

GitHub markdown'da metin için renk belirtmenin şu anda mümkün olmadığı konusunda Qwertman ile aynı fikirdeyim, en azından HTML aracılığıyla.

GitHub bazı HTML öğelerine ve niteliklerine izin verir, ancak yalnızca belirli olanlara (HTML sanitization hakkındaki belgelerine bakın). pvedivetiketlerinin yanı sıracolor` niteliğine de izin veriyorlar. Ancak, bunları GitHub'daki bir markdown belgesinde kullanmayı denediğimde, çalışmadı. Aşağıdakileri denedim (diğer varyasyonların yanı sıra) ve çalışmadılar:

  • <p style='color:red'>Bu biraz kırmızı metin.</p>
  • Bu bazı metinler!`
  • Bunlar kırmızı kelimeler.

Qwertman'ın önerdiği gibi, gerçekten renk kullanmanız gerekiyorsa, bunu bir README.html içinde yapabilir ve onları buna yönlendirebilirsiniz.

Yorumlar (2)