È possibile posizionare uno screenshot nel file README in un repository GitHub? Qual è la sintassi?
È possibile posizionare uno screenshot nel file README in un repository GitHub? Qual è la sintassi?
Risposte:
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=true
parametro per garantire correttamente il punto di repository biforcato.
Il raw=true
parametro è 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 true
pure: ?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 screenshots
per memorizzare le immagini, è possibile evitare che si trovino nell'albero di master
lavoro
È quindi possibile incorporarli utilizzando:
![Alt text](/../<branch name>/path/to/image.png?raw=true "Optional Title")
/relative/path/to/img.jpg
, non è un percorso assoluto a causa della barra iniziale?
raw=true
parametro è 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.
Anche se esiste già una risposta accettata, vorrei aggiungere un altro modo per caricare immagini da leggere su GitHub.
Maggiori dettagli puoi trovare qui
Ho scoperto che il percorso all'immagine nel mio repository non era sufficiente, ho dovuto collegarmi all'immagine sul raw.github.com
sottodominio.
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)
raw.github.com
sottodominio? dove caricare il file immagine?
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})
La sintassi del markdown per la visualizzazione delle immagini è infatti:
![image](https://{url})
MA: come fornire il url
?
Quindi ... puoi usare questo fantastico trucco per far ospitare a Github il tuo file immagine. TDLR:
http://solutionoptimist.com/2013/12/28/awesome-github-tricks/
Molto più semplice dell'aggiunta di URL Basta caricare un'immagine nello stesso repository, come:
![Screenshot](screenshot.png)
aggiungi questo a README
<div align="center">
<img src="/screenshots/screen1.jpg" width="400px"</img>
</div>
Markdown: ![Screenshot](http://url/to/img.png)
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 imgur
e ottenere il suo url e aggiungerlo nel tuo file README.md oppure puoi usare anche un hosting di file statico.
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
Innanzitutto, crea una directory (cartella) nella radice del repository locale che conterrà ciò screenshots
che 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.png
e 2_AlbumsActivity.png
nella 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!
Ho cercato su Google alcune domande simili e non ho visto alcuna risposta al mio problema e alla sua soluzione abbastanza semplice / facile.
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!
camo
- Immagini anonimeGithub 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:
https
non gs
) in una nuova scheda / finestra del browserSperiamo che questo aiuti ad accelerare e chiarire questo problema per chiunque altro.
Per me il modo migliore è -
Spero che questo possa aiutare.
Aggiungi l'immagine nel repository dall'opzione di caricamento del file, quindi nel file README
![Alt text]("enter image url of repositoryhere")
Con le immagini situate nella /screen-shots
directory. 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>
[Read more words!](docs/more_words.md)