githubリポジトリのREADMEにスクリーンショットを追加するにはどうすればよいですか?


595

GitHubリポジトリのREADMEファイルにスクリーンショットを配置することは可能ですか?構文は何ですか?


1
これに対する正しい解決策は、この回答に従って相対参照を使用することです。stackoverflow.com / a / 11916467/1633251(これを行う方法については、新しいgithubドキュメントへのリンクを含むコメントを参照してください)。短い答えは、使用することです[Read more words!](docs/more_words.md)
デビッドH

2
ほとんどのソリューションは、リポジトリ自体を指すことを提案しています。リポジトリー内のバイナリー(提案されているように、分離されたブランチ内であっても)を避け、外部の場所に保管したい場合はどうでしょうか?良い習慣はありますか?要旨(要旨がバイナリまたはテキストのみの場合はIDK)?プロジェクト「myproject」用に別のリポジトリ「myproject-assets」を作成しますか?動画をアップロードするためのYouTubeの事実上の標準に似た外部の人気の画像場所はありますか?
Xavi Montero


回答:


852

Markdown(README.md)を使用する場合:

リポジトリに画像がある場合は、相対URLを使用できます。

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

他の場所でホストされている画像を埋め込む必要がある場合は、完全なURLを使用できます

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

GitHubを使用することをお勧めします は、?raw=trueパラメーター付きの相対リンクをして、分岐されたリポジトリポイントが正しくなるようにする。

raw=trueパラメータがあるとしてレンダリングされます、あなたがにリンク画像を確保するためにあります。つまり、それぞれのファイルのGitHubインターフェース全体ではなく、画像のみがリンクされます。詳細については、このコメントを参照してください。

例を確認してください:https : //raw.github.com/altercation/solarized/master/README.md

SVGを使用する場合は、sanitize属性trueも同様に設定する必要があります。?raw=true&sanitize=true。(@EliShererに感謝)

また、READMEファイルの相対リンクに関するドキュメント: https //help.github.com/articles/relative-links-in-readmes

そしてもちろん、markdown docs: http //daringfireball.net/projects/markdown/syntax

さらに、screenshots画像を保存するための新しいブランチを作成する場合、それらがmaster作業ツリーます

次に、以下を使用してそれらを埋め込むことができます。

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

1
まあ、私は相対リンクに公式ドキュメントを追加しましたが、それらを使用するいくつかのリポジトリを見つけることができません。提案がある場合は、全体のポイントがスコープに留まらず、より多くの人々を助けているので、喜んでお手伝いします(ここで私の間違い)。
Paul

2
@Paul、これはまさにそれを行うリポジトリの例です!github.com/Tarrasch/zsh-bd
Tarrasch

4
github.com/altercation/solarizedは、上記の例のレンダリングされたバージョンです。
バリーカーター2015

3
あなたが言うとき/relative/path/to/img.jpg、それは先行スラッシュによる絶対パスではありませんか?
jww 2017

1
@ kelvin、raw=trueGitHubインターフェースではなく、GitHubパスが指す画像をレンダリングするためにパラメーターが存在します。違いを試してみて、参照してください。github.com/altercation/solarized/blob/master/img/...github.com/altercation/solarized/blob/master/img/...。最初のURLにはGitHubインターフェースと画像が表示され、2番目のURLには画像のみが表示されます。相対リンクは、レポジトリのクローンを作成/フォークするときにも役立ちます。そのため、そのパラメーターで相対パスを使用する必要がありますが、これらは2つの異なる概念です。
Paul

70

すでに承認された回答がありますが、GitHubのreadmeに画像をアップロードする別の方法を追加したいと思います。

  • リポジトリに課題を作成する必要があります
  • 画像をコメント領域にドラッグアンドドロップします
  • 画像のリンクが生成されたら、readmeに挿入します

ここで見つけることができる詳細


6
この方法でロードされた画像がどのくらいの期間存続するか興味があります。githubはいくつかの画像のクリーンアップを実行しますか?「この画像がgithubの問題から参照されていない場合、安全に削除できます」...
artin

1
@Artinはおそらく、問題が完全に削除された場合のみです。ドキュメントとデバッグで非常に重要な役割を果たすため、クローズドな問題は永遠に
残ります-andrhamm

55

私のリポジトリ内の画像へのパスでは不十分であることがわかりましたraw.github.com。サブドメインの画像にリンクする必要がありました。

URLフォーマット https://raw.github.com/{USERNAME}/{REPOSITORY}/{BRANCH}/{PATH}

マークダウンの例 ![Settings Window](https://raw.github.com/ryanmaxwell/iArrived/master/Screenshots/Settings.png)


4
承認された回答に対する@sorensコメントのため、これに反対票を投じます。絶対バスを指定することは、フォークされたリポジトリではうまく機能しないため、不適切です。(または、リポジトリの名前を変更した場合、またはgithubがドメイン名を変更した場合など)
LinusUnnebäck

7
@LinusUnnebäck:絶対パスimhoを使用する理由は1つあります。たとえば、readme.mdが他の場所、たとえばDoxygenメインページとして使用されている場合。その場合、相対リンクは機能しません。
Ela782 2015

1
@ Ela782ただし、詳細については、特にGitHubから READMEファイルをリッピングしているソフトウェアの問題でないはずです。このようなソフトウェアは、相対URLを適切に解決する必要があります。たとえば、npmはします。
Mark Amery

raw.github.comサブドメインの画像にリンクする方法は?画像ファイルをどこにアップロードしますか?
Saif 2017

@Saif raw.github.comは、githubリポジトリにコミットされている内容を反映しています。画像をリポジトリにコミットし、指定されたURL形式に従ってください。


21

下の1行はあなたが探しているものでなければなりません

ファイルがリポジトリにある場合

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

ファイルが他の外部URLにある場合

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

2
画像ファイルの相対リンクの使用を提案します。READMEの相対リンクを
shaobin0604

2
@ shaobin0604によって与えられた理由により-1。公式ドキュメントでは、自分のリポジトリ内のファイルにリンクするときに相対リンクを使用することを推奨しています。これにより、リンクが分岐したときに正しい場所を指すようになります。
Mark Amery 2016年

17

画像を表示するためのマークダウン構文は確かに次のとおりです。

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

しかし、どのように提供するのurlですか?

  • あなたはおそらくスクリーンショットであなたのリポジトリを乱雑にしたくないでしょう、彼らはコードとは何の関係もありません
  • Webで画像を利用できるようにする手間を省いたくないかもしれません...(サーバーにアップロードしてください...)。

だから...あなたはこの素晴らしいトリックを使ってgithubにあなたの画像ファイルをホストさせることができます。TDLR:

  1. リポジトリの課題リストに課題を作成します
  2. この問題のスクリーンショットをドラッグアンドドロップします
  3. 画像を表示するためにgithubが作成したマークダウンコードをコピーします
  4. readme(またはどこにでも)に貼り付けます

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


7

URLを追加するよりもはるかに簡単次のように、同じリポジトリに画像をアップロードするだけです。

![Screenshot](screenshot.png)



4

マークダウン: ![Screenshot](http://url/to/img.png)

  • 画像の追加に関する問題を作成する
  • ドラッグアンドドロップまたはファイルチューザーで画像を追加する
  • 次に、画像ソースをコピーします

  • 次に![Screenshot](http://url/to/img.png)、README.mdファイルに追加します

できた!

または、画像ホスティングサイトなどimgurを使用してそのURLを取得し、README.mdファイルに追加するか、静的ファイルホスティングを使用することもできます。

サンプル問題


私はずっと前にこれをしました、今、画像は利用できません。したがって、これはお勧めしません。
ナメック2017年

その場合は、常にimgurまたはカスタムイメージのcdnを使用できます:)
abe312

4

方法1->マークダウン方法

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

方法2-> HTMLの方法

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

または

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

->画像のスタイルを変更したくない場合、つまりサイズを変更したい場合は、スタイル部分を削除してください


1

まず、ローカルリポジトリのルートに、screenshots追加するディレクトリを含むディレクトリ(フォルダ)を作成します。このディレクトリの名前を呼びましょうscreenshots。追加する画像(JPEG、PNG、GIFなど)をこのディレクトリに配置します。

Android Studioワークスペースのスクリーンショット

次に、各画像へのリンクをREADMEに追加する必要があります。したがって、名前の付いた画像が1_ArtistsActivity.pngあり2_AlbumsActivity.png、私のスクリーンショットディレクトリにある場合は、次のようにリンクを追加します。

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

各スクリーンショットを別々の行に表示する場合は、リンクを別々の行に記述します。ただし、すべてのリンクをスペースのみで区切って1行で記述する方が適切です。見た目はあまり良くないかもしれませんが、そうすることでGitHubが自動的に配置してくれます。

最後に、変更をコミットしてプッシュします!


1

私はいくつかの同様の質問をググってみましたが、私の問題とその非常にシンプルで簡単な解決策については回答がありませんでした。

Google Cloud Storage-READMEの画像への少し異なるアプローチ

ここに行く:OPのように、Github READMEに画像が欲しくて、そうするためのMarkdown構文を知っていたので、次のように入力しました。

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

これを機能させるには、上記の実際の置換(例:MY_IMAGE = image.jpg)を完了する必要があります。

しかし、待ってください...失敗-実際にレンダリングされた写真はありません!そして、リンクはGoogle Storageによって与えられたとおりです!

失敗したGithub画像のアップロードのスクリーンショット

Github- camo匿名の画像

Githubは画像を匿名でホストしますで。ただし、これはGoogleストレージアセットに問題があります。Google Cloud Consoleから生成されたURLを取得する必要があります。

もっとスムーズな方法があると思いますが、指定されたURLエンドポイントにアクセスして長いURLをコピーするだけです。詳細:

指示

  1. ストレージコンソールにアクセスしますhttps : //console.cloud.google.com/storage/browser/ //console.cloud.google.com/storage/browser/ $ {MY_BUCKET}?project = $ {MY_PROJECT}
  2. Githubに表示する画像をクリックします([オブジェクトの詳細]ページが表示されます)
  3. そのURLをコピーします(httpsnotで始まるパスタ)gs)を新しいブラウザのタブ/ウィンドウにます
  4. 新しいブラウザのタブ/ウィンドウからGithub READMEファイルに、新しく生成されたURLのパスタをコピーします。

うまくいけば、これがスピードアップし、他の人のためにこの問題を明確にするのに役立ちます。


参考までに-GoogleまたはGithub側で何かが変わっているようです。READMEでこの方法で失敗する画像がいくつかあり、2020年3月28日の午後にいくつかの画像が機能しています。YMMVがここにあります!
Jason R Stevens CFA

0

私にとって最良の方法は-

  1. githubのリポジトリで新しい問題を作成し、ファイルをgif形式でアップロードします。ビデオファイルをgif形式に変換するには、このWebサイトhttp://www.online-convert.com/を使用できます
  2. 新しく作成した課題を送信します。
  3. アップロードされたファイルのアドレスをコピーします
  4. 最後に、READMEファイルに![demo](COPIED ADDRESS)

これがお役に立てば幸いです。


stackoverflow.com/a/32252663/1570104とどう違うのですか?
edelans

0

アップロードファイルオプションからREADMEファイルにリポジトリに画像を追加します

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

-5

画像は/screen-shotsディレクトリにあります。外側<div>は、画像を配置することができます。パディングはを使用して実現され<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
私の人生では、READMEの画像を中央に配置することが理解できませんでした-あなたの答えが含まれているので、ありがとう!
Cody Reichert、2015年

画像のサイズを設定できるので、この回答は役に立ちました
スタンリー
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.