1. ホーム
  2. github

[解決済み] github リポジトリの README にスクリーンショットを追加するには?

2022-03-15 13:35:18

質問

GitHubリポジトリのREADMEファイルにスクリーンショットを掲載することは可能でしょうか?どのような構文ですか?

どのように解決するのですか?

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

レポに画像があることが前提ですが、相対URLでOKです。

![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

もちろん、マークダウンのドキュメントも。 http://daringfireball.net/projects/markdown/syntax

さらに、新しいブランチを作成した場合 screenshots に格納することで、画像が master 作業ツリー

そして、それを使って埋め込むことができます。

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