Come aggiungere screenshot ai file README nel repository github?


595

È possibile posizionare uno screenshot nel file README in un repository GitHub? Qual è la sintassi?


1
La soluzione corretta a questo è utilizzare riferimenti relativi, per questa risposta stackoverflow.com/a/11916467/1633251 (vedere il commento con il collegamento a un nuovo documento github su come eseguire questa operazione). La risposta breve è usare[Read more words!](docs/more_words.md)
David H,

2
La maggior parte delle soluzioni propone di indicare il repository stesso. Che dire se vuoi evitare i binari nel repository (anche in un ramo separato, come proposto) e vuoi memorizzarlo in un luogo esterno? Qualche buona pratica? Forse un gist (IDK se gist può essere binario o solo testo)? creando un altro repository "myproject-assets" per il progetto "myproject"? Qualche luogo di immagini popolare esterno simile allo standard di fatto di YouTube per il caricamento di video?
Xavi Montero,


Risposte:


852

Se si utilizza Markdown (README.md):

A condizione che tu abbia l'immagine nel tuo repository, puoi utilizzare un URL relativo:

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

Se devi incorporare un'immagine ospitata altrove, puoi utilizzare un URL completo

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

GitHub consiglia di utilizzare i collegamenti relativi con il ?raw=trueparametro per garantire correttamente il punto di repository biforcato.

Il raw=trueparametro è lì per garantire che l'immagine a cui ci si collega, verrà resa così com'è. Ciò significa che verrà collegata solo l'immagine, non l'intera interfaccia GitHub per quel rispettivo file. Vedi questo commento per maggiori dettagli.

Guarda un esempio: https://raw.github.com/altercation/solarized/master/README.md

Se si utilizza SVG, allora avrete bisogno di impostare l'attributo sanitize a truepure: ?raw=true&sanitize=true. (Grazie @EliSherer)

Inoltre, la documentazione sui relativi collegamenti nei file README: https://help.github.com/articles/relative-links-in-readmes

E ovviamente i documenti di markdown: http://daringfireball.net/projects/markdown/syntax

Inoltre, se si crea un nuovo ramo screenshotsper memorizzare le immagini, è possibile evitare che si trovino nell'albero di masterlavoro

È quindi possibile incorporarli utilizzando:

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

1
Bene, ho aggiunto i documenti ufficiali sui relativi collegamenti, ma non riesco a trovare alcuni repository che li usano, se hai suggerimenti, sarò felice di aiutarti dato che l'intero punto è aiutare più persone, non rimanere nell'ambito (il mio errore qui).
Paul,

2
@Paul, ecco un repository di esempio che fa proprio questo! github.com/Tarrasch/zsh-bd
Tarrasch

4
github.com/altercation/solarized è la versione renderizzata dell'esempio sopra, nel caso in cui ciò aiuti qualcuno.
Barrycarter,

3
Quando dici /relative/path/to/img.jpg, non è un percorso assoluto a causa della barra iniziale?
jww

1
@kelvin, il raw=trueparametro è lì per rendere l'immagine a cui punta il percorso GitHub, non l'interfaccia GitHub. Prova a vedere la differenza: github.com/altercation/solarized/blob/master/img/… vs github.com/altercation/solarized/blob/master/img/… . Il primo URL ti mostrerà l'interfaccia di GitHub e l'immagine, mentre il secondo ti mostrerà solo l'immagine. I collegamenti relativi sono ancora utili durante la clonazione / il fork di repository, quindi sì, dovresti usare percorsi relativi con quel parametro, ma sono due concetti diversi.
Paul

70

Anche se esiste già una risposta accettata, vorrei aggiungere un altro modo per caricare immagini da leggere su GitHub.

  • Devi creare un problema nel tuo repository
  • Trascina e rilascia nell'area dei commenti la tua immagine
  • Dopo aver generato il collegamento per l'immagine, inseriscilo nel file Leggimi

Maggiori dettagli puoi trovare qui


6
Sono interessato per quanto tempo vivranno le immagini caricate in questo modo. Github esegue la pulizia di alcune immagini? Ad esempio, "se questa immagine non fa riferimento a nessun problema di github, posso rimuoverla in tutta sicurezza" ...
artin

1
@Artin probabilmente solo quando il problema verrà eliminato completamente. Le edizioni chiuse restano per sempre in quanto
ricoprono

55

Ho scoperto che il percorso all'immagine nel mio repository non era sufficiente, ho dovuto collegarmi all'immagine sul raw.github.comsottodominio.

Formato URL https://raw.github.com/{USERNAME}/{REPOSITORY}/{BRANCH}/{PATH}

Esempio di markdown ![Settings Window](https://raw.github.com/ryanmaxwell/iArrived/master/Screenshots/Settings.png)


4
Downvoting questo a causa del commento di @sorens sulla risposta accettata. È male specificare il bagno assoluto poiché non funzionerà bene sui repository biforcati. (O se si rinomina il repository o se github cambia il nome di dominio, ecc. Ecc.)
Linus Unnebäck

7
@ LinusUnnebäck: c'è un buon motivo per usare imho percorsi assoluti: se readme.md viene usato anche in altri luoghi, ad esempio come pagina principale di Doxygen. I collegamenti relativi non funzioneranno allora.
Ela782,

1
@ Ela782 anche se, in un'ulteriore nota, ciò non dovrebbe costituire un problema per il software che strappa file README specificamente da GitHub ; tale software dovrebbe sapere per risolvere correttamente gli URL relativi. npm lo fa , per esempio.
Mark Amery,

come collegarsi all'immagine sul raw.github.comsottodominio? dove caricare il file immagine?
Saif

@Saif raw.github.com è solo un riflesso di ciò che è impegnato nel tuo repository github. È sufficiente eseguire il commit dell'immagine nel repository e seguire il formato URL specificato.


21

Una riga di seguito dovrebbe essere quello che stai cercando

se il file è nel repository

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

se il tuo file si trova in un altro URL esterno

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

2
suggerire di utilizzare il collegamento relativo del file immagine, vedere Collegamenti relativi in ​​READMEs - Guida di Github
shaobin0604

2
-1 per il motivo fornito da @ shaobin0604; i documenti ufficiali raccomandano di utilizzare i collegamenti relativi quando si collega a un file nel proprio repository, in modo che il collegamento punti nel posto giusto quando viene biforcato.
Mark Amery,

17

La sintassi del markdown per la visualizzazione delle immagini è infatti:

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

MA: come fornire il url?

  • Probabilmente non vuoi ingombrare il tuo repository con schermate, non hanno nulla a che fare con il codice
  • potresti non voler nemmeno affrontare la seccatura di rendere la tua immagine disponibile sul web ... (caricarla su un server ...).

Quindi ... puoi usare questo fantastico trucco per far ospitare a Github il tuo file immagine. TDLR:

  1. crea un problema nell'elenco dei problemi del tuo repository
  2. trascina e rilascia lo screenshot su questo problema
  3. copia il codice markdown che github ha appena creato per farti visualizzare la tua immagine
  4. incollalo sul tuo readme (o dove vuoi)

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


7

Molto più semplice dell'aggiunta di URL Basta caricare un'immagine nello stesso repository, come:

![Screenshot](screenshot.png)


7

aggiungi questo a README

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

4

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

  • Crea un problema relativo all'aggiunta di immagini
  • Aggiungi l'immagine trascinandola o tramite il selettore file
  • Quindi copia la fonte dell'immagine

  • Ora aggiungi ![Screenshot](http://url/to/img.png)al tuo file README.md

Fatto!

In alternativa puoi usare alcuni siti di hosting di immagini come imgure ottenere il suo url e aggiungerlo nel tuo file README.md oppure puoi usare anche un hosting di file statico.

Problema di esempio


L'ho fatto molto tempo fa, ora le immagini non sono disponibili. Quindi non lo consiglio.
Namek,

In questo caso potresti sempre usare imgur o qualche immagine cdn personalizzata :)
abe312

4

Metodo 1-> Markdown way

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

Metodo 2-> Modo HTML

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

o

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

Nota -> Se non si desidera applicare uno stile all'immagine, ad esempio ridimensionare, rimuovere la parte di stile


1

Innanzitutto, crea una directory (cartella) nella radice del repository locale che conterrà ciò screenshotsche desideri aggiungere. Chiamiamo il nome di questa directory screenshots. Posiziona le immagini (JPEG, PNG, GIF, `ecc.) Che desideri aggiungere in questa directory.

Schermata dell'area di lavoro di Android Studio

In secondo luogo, è necessario aggiungere un collegamento a ciascuna immagine nel proprio README. Quindi, se ho le immagini nominate 1_ArtistsActivity.pnge 2_AlbumsActivity.pngnella mia directory schermate, aggiungerò i loro collegamenti in questo modo:

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

Se si desidera ogni screenshot su una riga separata, scrivere i relativi collegamenti su righe separate. Tuttavia, è meglio se si scrivono tutti i collegamenti in una riga, separati solo dallo spazio. In realtà potrebbe non sembrare troppo bello, ma facendo così GitHub li organizza automaticamente per te.

Infine, esegui il commit delle modifiche e spingilo!


1

Ho cercato su Google alcune domande simili e non ho visto alcuna risposta al mio problema e alla sua soluzione abbastanza semplice / facile.

Google Cloud Storage: un approccio leggermente diverso alle immagini in README

Ecco qui: come l'OP, volevo un'immagine nel mio README di Github e, conoscendo la sintassi di Markdown per farlo, l'ho digitata:

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

È necessario completare le sostituzioni effettive sopra (ad esempio MY_IMAGE = image.jpg) affinché funzioni.

Ma aspetta ... fallimento - non c'è una vera foto renderizzata! E il link è esattamente come indicato da Google Storage!

screenshot del caricamento dell'immagine di Github non riuscito

Github camo- Immagini anonime

Github ospita le tue immagini in modo anonimo , yay! Tuttavia, ciò presenta un problema per le risorse di archiviazione di Google. Devi ottenere l'URL generato dalla tua Google Cloud Console.

Sono sicuro che esiste un modo più semplice, tuttavia, visita semplicemente il tuo endpoint URL specificato e copia l'URL lungo. Dettagli:

Istruzioni

  1. Visita la tua console di archiviazione: https://console.cloud.google.com/storage/browser/ $ {MY_BUCKET}? Project = $ {MY_PROJECT}
  2. Fai clic sull'immagine che desideri visualizzare in Github (viene visualizzata la pagina "Dettagli oggetto")
  3. Copia pasta quell'URL (quello che inizia con httpsnon gs) in una nuova scheda / finestra del browser
  4. Copia pasta il nuovo URL generato - dovrebbe essere più lungo - dalla nuova scheda / finestra del browser nel file README di Github

Speriamo che questo aiuti ad accelerare e chiarire questo problema per chiunque altro.


Cordiali saluti - Sembra che qualcosa stia cambiando sul lato Google o Github delle cose. Ho avuto alcune immagini in README che non funzionavano con questo metodo e alcune funzionavano dal pomeriggio del 28 marzo 2020. Qui YMMV!
Jason R Stevens CFA

0

Per me il modo migliore è -

  1. Crea un nuovo problema con quel repository su github e poi carica il file in formato gif. Per convertire i file video in formato gif puoi usare questo sito web http://www.online-convert.com/
  2. Invia il problema appena creato.
  3. Copia l'indirizzo del file caricato
  4. Finalmente nel tuo file README metti! [Demo] (COPIED ADDRESS)

Spero che questo possa aiutare.



0

Aggiungi l'immagine nel repository dall'opzione di caricamento del file, quindi nel file README

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

-5

Con le immagini situate nella /screen-shotsdirectory. L'esterno <div>consente di posizionare le immagini. L'imbottitura si ottiene usando <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
Per la mia vita non sono riuscito a capire come centrare un'immagine nel README - che contiene la tua risposta, quindi grazie!
Cody Reichert,

Ho trovato utile questa risposta poiché ti consente di impostare le dimensioni dell'immagine
Stanley,
Utilizzando il nostro sito, riconosci di aver letto e compreso le nostre Informativa sui cookie e Informativa sulla privacy.
Licensed under cc by-sa 3.0 with attribution required.