Github deposundaki README'lere ekran görüntüsü nasıl eklenir?


594

GitHub deposundaki README dosyasına bir ekran görüntüsü yerleştirmek mümkün müdür? Sözdizimi nedir?


1
Bunun için doğru çözüm, bu yanıt başına göreceli referanslar kullanmaktır stackoverflow.com/a/11916467/1633251 (bunun nasıl yapılacağı ile ilgili yeni bir github dokümanı bağlantısıyla ilgili yoruma bakın). Kısa cevap kullanmaktır[Read more words!](docs/more_words.md)
David H

2
Çoğu çözüm, repoya işaret etmeyi önerir. Repodaki ikili dosyalardan (önerildiği gibi ayrılmış bir dalda bile) kaçınmak ve harici bir yerde saklamak istiyorsanız ne olur? İyi uygulamalar var mı? Bir gist belki (gist ikili veya sadece metin olabilirse IDK)? "projem" projesi için başka bir repo "projem varlıkları" oluşturuluyor mu? Video yüklemek için youtube'un de-facto standardına benzer herhangi bir harici popüler resim yeri?
Xavi Montero


Yanıtlar:


851

Markdown (README.md) kullanıyorsanız:

Reponuzda resim olması koşuluyla, göreli bir URL kullanabilirsiniz:

![Alt text](/relative/path/to/img.jpg?raw=true "Optional Title")

Başka bir yerde barındırılan bir resmi yerleştirmeniz gerekiyorsa, tam bir URL kullanabilirsiniz

![Alt text](http://full/path/to/img.jpg "Optional title")

GitHub , çatallı depoların doğru bir şekilde işaretlenmesini sağlamak için parametre ile göreli bağlantılar kullanmanızı önerir ?raw=true.

raw=trueParametre bağlanmak görüntüyü sağlamak amacıyla, orada olduğu gibi görüntüleniyor. Bu, söz konusu dosya için tüm GitHub arayüzüne değil, yalnızca görüntüye bağlanılacağı anlamına gelir. Daha fazla ayrıntı için bu yoruma bakın.

Bir örneği inceleyin: https://raw.github.com/altercation/solarized/master/README.md

Eğer SVG lezyonu kullanırsanız o zaman için sterilize özelliğini ayarlamak gerekir trueyanı: ?raw=true&sanitize=true. (Teşekkürler @EliSherer)

Ayrıca, README dosyalarındaki göreli bağlantılar hakkındaki belgeler: https://help.github.com/articles/relative-links-in-readmes

Ve elbette markdown belgeleri: http://daringfireball.net/projects/markdown/syntax

Ayrıca, screenshotsgörüntüleri saklamak için yeni bir dal oluşturursanız , masterçalışma ağacında olmalarını önleyebilirsiniz

Daha sonra bunları kullanarak gömebilirsiniz:

![Alt text](/../<branch name>/path/to/image.png?raw=true "Optional Title")

1
Resmi dokümanları göreli bağlantılara ekledim, ancak bunları kullanan bir repo bulamıyorum, önerileriniz varsa, tüm nokta daha fazla insana yardım ediyor, kapsamda kalmamaktan dolayı yardımcı olmaktan memnuniyet duyarız. (benim hatam burada).
Paul

2
@ Paul, işte tam da bunu yapan bir örnek havuz! Github.com/Tarrasch/zsh-bd
Tarrasch

4
github.com/altercation/solarized , herkese yardımcı olması durumunda yukarıdaki örneğin oluşturulmuş sürümüdür.
barrycarter

3
Söylediğinizde /relative/path/to/img.jpg, bu eğik çizgi nedeniyle mutlak bir yol değil mi?
jww

1
@kelvin, raw=trueparametre GitHub arabirimini değil, GitHub yolunun işaret ettiği görüntüyü oluşturmak için vardır. Farkı deneyin ve görün: github.com/altercation/solarized/blob/master/img/… vs github.com/altercation/solarized/blob/master/img/… . İlk URL size GitHub arayüzünü ve resmi, ikincisi ise yalnızca resmi gösterir. Depoları klonlarken / çatallarken göreli bağlantılar hala yararlıdır, bu nedenle evet bu parametreyle göreli yollar kullanmalısınız, ancak bunlar iki farklı kavramdır.
Paul

70

Kabul edilmiş bir cevap olmasına rağmen GitHub'da benioku görüntülerini yüklemek için başka bir yol eklemek istiyorum.

  • Reponuzda sorun yaratmanız gerekiyor
  • Resminizi yorum alanına sürükleyip bırakın
  • Resmin bağlantısı oluşturulduktan sonra benioku dosyasına ekleyin

Daha fazla ayrıntıyı burada bulabilirsiniz


6
Bu şekilde yüklenen görüntülerin ne kadar yaşayacağını merak ediyorum. Github bazı görüntü temizleme işlemleri yapıyor mu? Gibi, "Bu görüntü herhangi bir github sorun referans değil, güvenle kaldırabilirim" ...
artin

1
@Artin yalnızca sorun tamamen silindiğinde. Kapalı konular dokümantasyon ve hata ayıklamada çok önemli bir rol oynadıkları için sonsuza dek
sürüyor

55

Repo'mdaki görüntüye giden yolun yeterli olmadığını, raw.github.comalt alandaki görüntüye bağlanmak zorunda olduğumu fark ettim .

URL biçimi https://raw.github.com/{USERNAME}/{REPOSITORY}/{BRANCH}/{PATH}

Markdown örneği ![Settings Window](https://raw.github.com/ryanmaxwell/iArrived/master/Screenshots/Settings.png)


4
@Sorens'in kabul edilen cevaba yaptığı yorum nedeniyle bunu küçümsemek. Mutlak banyo belirlemek kötüdür çünkü çatallı depolarda iyi çalışmaz. (Veya
repo'nuzu

7
@ LinusUnnebäck: Mutlak yolları kullanmanın iyi bir nedeni var imho: Benioku.md dosyası örneğin Doxygen ana sayfası olarak başka yerlerde de kullanılıyorsa. Göreli bağlantılar o zaman çalışmaz.
Ela782

1
Ela782 @, her ne kadar başka bir not, o gerektiğini README dosyalarını Yırtılıyor yazılım için bir sorun değil GitHub özellikle ; bu tür yazılımlar göreli URL'leri düzgün bir şekilde çözmeyi bilmelidir. npm örneğin.
Mark Amery

raw.github.comalt alandaki resme nasıl bağlanır? görüntü dosyası nereye yüklenir?
Saif

@Saif raw.github.com, github veri havuzunuza adanmış olanların sadece bir yansımasıdır. Görüntüyü deponuza vermeniz ve belirtilen URL biçimini izlemeniz yeterlidir.


21

Aşağıdaki satırlardan biri aradığınız şey olmalıdır

dosyanız depodaysa

![ScreenShot](https://raw.github.com/{username}/{repository}/{branch}/{path})

dosyanız başka bir harici URL'de ise

![ScreenShot](https://{url})

2
görüntü dosyasının göreli bağlantısını kullanmanızı öneririz, bkz . README'lerde göreli bağlantılar - Github Yardım
shaobin0604

2
@ Shaobin0604 tarafından verilen nedenden dolayı -1; resmi dokümanlar, kendi deponuzdaki bir dosyaya bağlanırken göreli bağlantılar kullanmanızı önerir, böylece bağlantı çatallandığında doğru yeri gösterir.
Mark Amery

17

Görüntüleri görüntülemek için kullanılan işaretleme sözdizimi aslında:

![image](https://{url})

AMA: Nasıl sağlanır url?

  • Muhtemelen repo'nuzu ekran görüntüleri ile karıştırmak istemiyorsunuz, kodla ilgileri yok
  • resminizi web'de kullanılabilir hale getirme zahmetiyle de uğraşmak istemeyebilirsiniz ... (bir sunucuya yükleyin ...).

Yani ... bu harika numarayı kullanabilirsiniz github'u görüntü dosyanızı barındırmak için . TDLR:

  1. repo'nuzun sayı listesinde bir sorun yaratın
  2. bu konuda ekran görüntünüzü sürükleyip bırakın
  3. github'un sizin için oluşturduğu işaretleme kodunu kopyalayınresminizi görüntülemeniz
  4. benioku üzerine (veya istediğiniz yere) yapıştırın

http://solutionoptimist.com/2013/12/28/awesome-github-tricks/


7

URL eklemekten çok daha basit Aynı depoya bir resim yükleyin, örneğin:

![Screenshot](screenshot.png)


7

bunu README'ye ekle

<div align="center">
    <img src="/screenshots/screen1.jpg" width="400px"</img> 
</div>

4

Markdown: ![Screenshot](http://url/to/img.png)

  • Resim eklemeyle ilgili bir sorun oluşturun
  • Resmi sürükleyip bırakarak veya dosya seçiciyle ekleyin
  • Ardından görüntü kaynağını kopyalayın

  • Şimdi ![Screenshot](http://url/to/img.png)README.md dosyanıza ekleyin

Bitti!

Alternatif olarak bazı görüntü barındırma sitelerini kullanabilir imgurve URL'sini alıp README.md dosyanıza ekleyebilirsiniz ya da bazı statik dosya barındırma da kullanabilirsiniz.

Örnek sorun


Bunu uzun zaman önce yaptım, şimdi görüntüler mevcut değil. Bu yüzden bunu tavsiye etmiyorum.
Namek

Bu durumda her zaman imgur veya bazı özel resim cdn'lerini kullanabilirsiniz :)
abe312 30:17

4

Yöntem 1-> İşaretleme yolu

![Alt Text](https://raw.github.com/{USERNAME}/{REPOSITORY}/{BRANCH}/{PATH})

Yöntem 2-> HTML yolu

<img src="https://link(format same as above)" width="100" height="100"/>

veya

<img src="https://link" style=" width:100px ; height:100px " />

Not -> Resminizi şekillendirmek istemiyorsanız, örneğin yeniden boyutlandırın stil parçasını kaldırın


1

İlk olarak, yerel repo dosyanızın kökünde screenshotseklenmesini istediğiniz dizini (klasör) oluşturun . Bu dizinin adını çağıralım screenshots. Bu dizine eklemek istediğiniz görüntüleri (JPEG, PNG, GIF, `vb.) Yerleştirin.

Android Studio Çalışma Alanı Ekran Görüntüsü

İkinci olarak, her resme README'nize bir bağlantı eklemeniz gerekir. Bu nedenle, adlandırılmış görüntülerim varsa 1_ArtistsActivity.pngve 2_AlbumsActivity.pngekran görüntüleri dizinimde, bağlantılarını şöyle ekleyeceğim:

 <img src="screenshots/1_ArtistsActivity.png" height="400" alt="Screenshot"/> <img src=“screenshots/2_AlbumsActivity.png" height="400" alt="Screenshot"/>

Her ekran görüntüsünü ayrı bir satıra istiyorsanız bağlantılarını ayrı satırlara yazın. Ancak, tüm bağlantıları yalnızca boşlukla ayrılmış bir satırda yazarsanız daha iyi olur. Aslında çok iyi görünmeyebilir, ancak bunu yaparak GitHub bunları sizin için otomatik olarak düzenler.

Son olarak, değişikliklerinizi yapın ve itin!


1

Birkaç benzer soruyu araştırdım ve sorunumla ve oldukça basit / kolay çözümü ile herhangi bir cevap görmedim.

Google Cloud Storage - README'lerde görüntülere biraz farklı bir yaklaşım

İşte gidiyor: OP gibi, Github README'mde bir görüntü istedim ve Markdown sözdizimini bilerek bunu yazdım:

![My Image](https://storage.cloud.google.com/${MY_BUCKET}/${MY_IMAGE}

Bunun çalışması için yukarıdaki gerçek değişiklikleri (örn. MY_IMAGE = image.jpg) tamamlamanız gerekir.

Ancak, bekleyin ... başarısızlık - gerçek bir fotoğraf yok! Ve bağlantı tam olarak Google Storage tarafından verildiği gibidir!

başarısız Github resim yüklemesinin ekran görüntüsü

Github camo- İsimsiz Görüntüler

Github resimlerinizi anonim olarak barındırıyor , yay! Ancak bu, Google depolama öğeleri için bir sorun oluşturur. Oluşturulan URL'yi Google Cloud Konsolunuzdan almanız gerekir.

Daha yumuşak bir yol olduğundan eminim, ancak verilen URL uç noktanızı ziyaret edin ve uzun URL'yi kopyalayın. Detaylar:

Talimatlar

  1. Depolama konsolunuzu ziyaret edin: https://console.cloud.google.com/storage/browser/ $ {MY_BUCKET}? Project = $ {MY_PROJECT}
  2. Github'da görüntülemek istediğiniz görüntüyü tıklayın (bu, "Nesne Ayrıntıları" sayfasını getirir)
  3. URL'yi (başlangıçtan başlayarak httpsdeğil gs) yeni bir tarayıcı sekmesine / penceresine kopyalayın
  4. Makarna yeni oluşturulan URL'yi (daha uzun olmalıdır) yeni tarayıcı sekmenizden / pencerenizden Github README dosyanıza kopyalayın

Umarım bu, bu sorunu herkes için hızlandırmaya ve açıklığa kavuşturmaya yardımcı olur.


Bilginize - Görünüşe göre şeylerin Google veya Github tarafında bir şeyler değişiyor. README'lerde bazı görüntüler bu yöntemle başarısız oldu ve bazıları 28 Mart 2020 öğleden sonra çalışıyor. YMMV burada!
Jason R Stevens CFA


0

Dosyayı karşıya yükleme seçeneğinden depoya resim ve ardından README dosyasına ekleyin

![Alt text]("enter image url of repositoryhere") 

-5

Görüntüler /screen-shotsdizinde bulunur. Dış <div>kısım, görüntülerin konumlandırılmasını sağlar. Dolgu kullanılarak elde edilir <img width="desired-padding" height="0">.

<div align="center">
        <img width="45%" src="screen-shots/about.PNG" alt="About screen" title="About screen"</img>
        <img height="0" width="8px">
        <img width="45%" src="screen-shots/list.PNG" alt="List screen" title="List screen"></img>
</div>

1
Hayatım boyunca, cevabınızı içeren README'de bir görüntüyü merkezleyemedim, bu yüzden teşekkürler!
Cody Reichert

Görüntünün boyutlarını ayarlamanıza izin verdiği için bu yanıtı yararlı buldum
Stanley
Sitemizi kullandığınızda şunları okuyup anladığınızı kabul etmiş olursunuz: Çerez Politikası ve Gizlilik Politikası.
Licensed under cc by-sa 3.0 with attribution required.