A solução correta para isso é usar referências relativas, de acordo com esta resposta stackoverflow.com/a/11916467/1633251 (consulte o comentário no link para um novo documento do github sobre como fazer isso). A resposta curta é usar[Read more words!](docs/more_words.md)
David H
2
A maioria das soluções propõe apontar para o repo em si. E se você deseja evitar binários no repositório (mesmo em uma ramificação separada, conforme proposto) e deseja armazená-lo em um local externo? Alguma boa prática? Uma essência talvez (IDK se essência puder ser binária ou apenas texto)? criando outro repositório "myproject-assets" para o projeto "myproject"? Algum local de imagem popular externo semelhante ao padrão de fato do youtube para enviar vídeos?
O GitHub recomenda que você use links relativos com o ?raw=trueparâmetro para garantir que os repositórios bifurcados aponte corretamente.
O raw=trueparâmetro está lá para garantir que a imagem à qual você vincula seja renderizada como está. Isso significa que apenas a imagem será vinculada, não toda a interface do GitHub para o respectivo arquivo. Veja este comentário para mais detalhes.
Bem, adicionei os documentos oficiais em links relativos, mas não consigo encontrar algum repositório que os use; se você tiver sugestões, terei prazer em ajudar, pois o objetivo é ajudar mais pessoas, não permanecer no escopo (meu erro aqui).
Quando você diz /relative/path/to/img.jpg, esse não é um caminho absoluto devido à barra principal?
JWW
1
@kelvin, o raw=trueparâmetro existe para renderizar a imagem que o caminho do GitHub aponta, não a interface do GitHub. Experimente e veja a diferença: github.com/altercation/solarized/blob/master/img/… vs github.com/altercation/solarized/blob/master/img/… . O primeiro URL mostrará a interface do GitHub e a imagem, enquanto o segundo mostrará apenas a imagem. Os links relativos ainda são úteis durante a clonagem / bifurcação de repositórios, portanto, sim, você deve usar caminhos relativos com esse parâmetro, mas são dois conceitos diferentes.
Paul
70
Embora já exista uma resposta aceita, gostaria de adicionar outra maneira de fazer upload de imagens para leia-me no GitHub.
Você precisa criar um problema no seu repositório
Arraste e solte na área de comentários sua imagem
Após o link da imagem ser gerado, insira-o no seu leia-me
Estou interessado em quanto tempo as imagens carregadas dessa maneira permanecerão. O github executa a limpeza de algumas imagens? Como, "se esta imagem não for referenciada em nenhum problema do github, eu posso removê-la com segurança" ...
artin 7/08/17
1
@ Artin provavelmente apenas quando o problema for excluído completamente. Questões fechadas ficar por aqui para sempre como eles servem um papel muito importante na documentação e depuração
andrhamm
55
Descobri que o caminho para a imagem no meu repositório não era suficiente, eu tinha que vincular à imagem no raw.github.comsubdomínio.
Formato de URL https://raw.github.com/{USERNAME}/{REPOSITORY}/{BRANCH}/{PATH}
Exemplo de remarcação ![Settings Window](https://raw.github.com/ryanmaxwell/iArrived/master/Screenshots/Settings.png)
Voto negativo por causa do comentário do @sorens sobre a resposta aceita. É ruim especificar banho absoluto, pois não funcionará bem em repositórios bifurcados. (Ou se você mudar o nome do repo, ou se github muda nome de domínio, etc. etc.)
Linus Unnebäck
7
@ LinusUnnebäck: Há um bom motivo para usar caminhos absolutos imho: se o readme.md também for usado em outros lugares, por exemplo, na página principal do Doxygen. Links relativos não funcionarão então.
Ela782
1
@ Ela782, embora, em uma observação adicional, isso não deva ser um problema para o software que está copiando arquivos README especificamente do GitHub ; esse software deve saber resolver URLs relativos adequadamente. npm faz , por exemplo.
Mark Amery
como vincular à imagem no raw.github.comsubdomínio? onde carregar o arquivo de imagem?
Saif
O @Saif raw.github.com é apenas um reflexo do que está comprometido com seu repositório do github. Apenas envie a imagem ao seu repositório e siga o formato de URL especificado.
sugerir o uso do link relativo do arquivo de imagem, consulte Links relativos em
READMEs
2
-1 pelo motivo fornecido por @ shaobin0604; os documentos oficiais recomendam o uso de links relativos ao vincular a um arquivo em seu próprio repositório, para que o link aponte para o lugar certo quando for bifurcado.
Mark Amery
17
A sintaxe de remarcação para exibir imagens é de fato:
![image](https://{url})
MAS: Como fornecer o url?
Você provavelmente não deseja confundir seu repositório com capturas de tela, elas não têm nada a ver com código
você pode não querer lidar com o incômodo de disponibilizar sua imagem na web ... (faça o upload para um servidor ...).
Então ... você pode usar esse truque incrível para fazer o github hospedar seu arquivo de imagem. TDLR:
crie um problema na lista de problemas do seu repositório
arraste e solte sua captura de tela sobre esse problema
copie o código de remarcação que o github acabou de criar para você exibir sua imagem
Adicione a imagem arrastando e soltando ou pelo seletor de arquivos
Em seguida, copie a fonte da imagem
Agora adicione ![Screenshot](http://url/to/img.png)ao seu arquivo README.md
Feito!
Como alternativa, você pode usar algum site de hospedagem de imagens, como imguro URL, e adicioná-lo ao seu arquivo README.md, ou você também pode usar alguma hospedagem de arquivo estática.
Primeiro, crie um diretório (pasta) na raiz do seu repositório local que conterá o que screenshotsvocê deseja adicionar. Vamos chamar o nome desse diretório screenshots. Coloque as imagens (JPEG, PNG, GIF, `etc) que você deseja adicionar neste diretório.
Em segundo lugar, você precisa adicionar um link para cada imagem no seu README. Portanto, se eu tiver imagens nomeadas 1_ArtistsActivity.pnge 2_AlbumsActivity.pngno meu diretório de capturas de tela, adicionarei os links assim:
Se você quiser cada captura de tela em uma linha separada, escreva seus links em linhas separadas. No entanto, é melhor se você escrever todos os links em uma linha, separados apenas por espaço. Pode até não parecer muito bom, mas ao fazê-lo, o GitHub os organiza automaticamente para você.
Você precisa concluir as substituições reais acima (por exemplo, MY_IMAGE = image.jpg) para que isso funcione.
Mas espere ... falha - não há foto renderizada real! E o link é exatamente o fornecido pelo Google Storage!
Github camo- Imagens Anônimas
O Github hospeda suas imagens anonimamente , yay! No entanto, isso apresenta um problema para os ativos de armazenamento do Google. Você precisa obter o URL gerado no seu Google Cloud Console.
Tenho certeza de que há uma maneira mais suave, no entanto, basta visitar o terminal de URL especificado e copiar o URL longo. Detalhes:
FYI - Parece que algo está mudando no lado do Google ou do Github. Eu tive algumas imagens nos READMEs que falharam com esse método e algumas funcionaram na tarde de 28 de março de 2020. YMMV aqui!
Jason R Stevens CFA
0
Para mim, o melhor caminho é -
Crie um novo problema com esse repositório no github e faça o upload do arquivo no formato gif. Para converter arquivos de vídeo em formato gif, você pode usar este site http://www.online-convert.com/
Envie o problema recém-criado.
Copie o endereço do arquivo carregado
Finalmente, no seu arquivo LEIA-ME, coloque! [Demo] (ENDEREÇO COPIADO)
Com as imagens localizadas no /screen-shotsdiretório O exterior <div>permite que as imagens sejam posicionadas. O preenchimento é obtido usando <img width="desired-padding" height="0">.
[Read more words!](docs/more_words.md)
Respostas:
Se você usar o Markdown (README.md):
Desde que você tenha a imagem em seu repositório, você pode usar um URL relativo:
Se você precisar incorporar uma imagem hospedada em outro lugar, poderá usar um URL completo
O GitHub recomenda que você use links relativos com o
?raw=true
parâmetro para garantir que os repositórios bifurcados aponte corretamente.O
raw=true
parâmetro está lá para garantir que a imagem à qual você vincula seja renderizada como está. Isso significa que apenas a imagem será vinculada, não toda a interface do GitHub para o respectivo arquivo. Veja este comentário para mais detalhes.Confira um exemplo: https://raw.github.com/altercation/solarized/master/README.md
Se você usar SVGs então você precisa para definir o atributo sanitize para
true
assim:?raw=true&sanitize=true
. (Obrigado @EliSherer)Além disso, a documentação sobre links relativos nos arquivos README: https://help.github.com/articles/relative-links-in-readmes
E, claro, os documentos de remarcação: http://daringfireball.net/projects/markdown/syntax
Além disso, se você criar uma nova ramificação
screenshots
para armazenar as imagens, poderá evitar que elas estejam namaster
árvore de trabalhoVocê pode incorporá-los usando:
fonte
/relative/path/to/img.jpg
, esse não é um caminho absoluto devido à barra principal?raw=true
parâmetro existe para renderizar a imagem que o caminho do GitHub aponta, não a interface do GitHub. Experimente e veja a diferença: github.com/altercation/solarized/blob/master/img/… vs github.com/altercation/solarized/blob/master/img/… . O primeiro URL mostrará a interface do GitHub e a imagem, enquanto o segundo mostrará apenas a imagem. Os links relativos ainda são úteis durante a clonagem / bifurcação de repositórios, portanto, sim, você deve usar caminhos relativos com esse parâmetro, mas são dois conceitos diferentes.Embora já exista uma resposta aceita, gostaria de adicionar outra maneira de fazer upload de imagens para leia-me no GitHub.
Mais detalhes você pode encontrar aqui
fonte
Descobri que o caminho para a imagem no meu repositório não era suficiente, eu tinha que vincular à imagem no
raw.github.com
subdomínio.Formato de URL
https://raw.github.com/{USERNAME}/{REPOSITORY}/{BRANCH}/{PATH}
Exemplo de remarcação
![Settings Window](https://raw.github.com/ryanmaxwell/iArrived/master/Screenshots/Settings.png)
fonte
raw.github.com
subdomínio? onde carregar o arquivo de imagem?fonte
Uma linha abaixo deve ser o que você procura
se o seu arquivo estiver no repositório
se o seu arquivo estiver em outro URL externo
fonte
A sintaxe de remarcação para exibir imagens é de fato:
MAS: Como fornecer o
url
?Então ... você pode usar esse truque incrível para fazer o github hospedar seu arquivo de imagem. TDLR:
http://solutionoptimist.com/2013/12/28/awesome-github-tricks/
fonte
Muito mais simples do que adicionar URL Apenas envie uma imagem para o mesmo repositório, como:
![Screenshot](screenshot.png)
fonte
adicione isso ao README
fonte
Remarcação:
![Screenshot](http://url/to/img.png)
Em seguida, copie a fonte da imagem
Agora adicione
![Screenshot](http://url/to/img.png)
ao seu arquivo README.mdFeito!
Como alternativa, você pode usar algum site de hospedagem de imagens, como
imgur
o URL, e adicioná-lo ao seu arquivo README.md, ou você também pode usar alguma hospedagem de arquivo estática.Problema de amostra
fonte
Método 1-> maneira Markdown
Método 2-> maneira HTML
ou
Nota -> Se você não deseja estilizar sua imagem, ou seja, redimensionar, remova a parte do estilo
fonte
Primeiro, crie um diretório (pasta) na raiz do seu repositório local que conterá o que
screenshots
você deseja adicionar. Vamos chamar o nome desse diretórioscreenshots
. Coloque as imagens (JPEG, PNG, GIF, `etc) que você deseja adicionar neste diretório.Captura de tela da área de trabalho do Android Studio
Em segundo lugar, você precisa adicionar um link para cada imagem no seu README. Portanto, se eu tiver imagens nomeadas
1_ArtistsActivity.png
e2_AlbumsActivity.png
no meu diretório de capturas de tela, adicionarei os links assim:Se você quiser cada captura de tela em uma linha separada, escreva seus links em linhas separadas. No entanto, é melhor se você escrever todos os links em uma linha, separados apenas por espaço. Pode até não parecer muito bom, mas ao fazê-lo, o GitHub os organiza automaticamente para você.
Por fim, confirme suas alterações e pressione-o!
fonte
Pesquisei no Google algumas perguntas semelhantes e não encontrei respostas para o meu problema e sua solução bastante simples / fácil.
Google Cloud Storage - uma abordagem ligeiramente diferente para imagens em READMEs
Aqui está: como o OP, eu queria uma imagem no meu README do Github e, conhecendo a sintaxe do Markdown para isso, digitei:
Você precisa concluir as substituições reais acima (por exemplo, MY_IMAGE = image.jpg) para que isso funcione.
Github
camo
- Imagens AnônimasO Github hospeda suas imagens anonimamente , yay! No entanto, isso apresenta um problema para os ativos de armazenamento do Google. Você precisa obter o URL gerado no seu Google Cloud Console.
Tenho certeza de que há uma maneira mais suave, no entanto, basta visitar o terminal de URL especificado e copiar o URL longo. Detalhes:
Instruções
https
nãogs
) em uma nova guia / janela do navegadorEsperemos que isso ajude a acelerar e esclarecer esse problema para qualquer outra pessoa.
fonte
Para mim, o melhor caminho é -
Espero que isso ajude.
fonte
Adicionar imagem no repositório a partir da opção de upload de arquivo e depois no arquivo README
fonte
Com as imagens localizadas no
/screen-shots
diretório O exterior<div>
permite que as imagens sejam posicionadas. O preenchimento é obtido usando<img width="desired-padding" height="0">
.fonte