☰

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

tag-icon • tag-icon github markdown
GithubリポジトリのREADMEにスクリーンショットを追加するにはどうすればいいですか? 質問する

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

ベストアンサー1

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

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

screenshotsさらに、画像を保存するための新しいブランチを作成すると、master作業ツリーに画像が保存されるのを防ぐことができます。

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

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

おすすめ記事