Как добавить скриншот в README в репозитории github?


595

Можно ли поместить скриншот в файл README в репозиторий GitHub? Какой синтаксис?


1
Правильным решением этого является использование относительных ссылок, согласно этому ответу stackoverflow.com/a/11916467/1633251 (см. Комментарий со ссылкой на новый документ Github о том, как это сделать). Короткий ответ заключается в использовании[Read more words!](docs/more_words.md)
David H

2
Большинство решений предлагают указать на сам репо. Что делать, если вы хотите избежать бинарных файлов в репо (даже в отдельной ветке, как предложено) и хотите сохранить его во внешнем месте? Есть хорошие практики? Суть может быть (IDK, если суть может быть двоичным или просто текст)? создание еще одного репо "myproject-assets" для проекта "myproject"? Есть ли какое-нибудь внешнее популярное изображение-место, похожее на де-факто стандарт YouTube для загрузки видео?
Хави Монтеро


Ответы:


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

Если вы используете SVGs , то вам необходимо установить атрибут дезинфицировать к 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")

1
Ну, я добавил официальные документы по относительным ссылкам, но я не могу найти репозиторий, который использует их, если у вас есть предложения, я буду рад помочь, поскольку весь смысл в том, чтобы помогать большему количеству людей, а не оставаться в поле зрения. (моя ошибка здесь).
Пол

2
@Paul, вот пример репозитория, делающего именно это! github.com/Tarrasch/zsh-bd
Tarrasch

4
github.com/altercation/solarized - предоставленная версия примера выше, в случае, если это кому-нибудь поможет.
Баррикартер

3
Когда вы говорите /relative/path/to/img.jpg, разве это не абсолютный путь из-за ведущего слэша?
jww

1
@kelvin, raw=trueпараметр существует для того, чтобы визуализировать изображение, на которое указывает путь GitHub, а не интерфейс GitHub. Попробуйте увидеть разницу: github.com/altercation/solarized/blob/master/img/…s против github.com/altercation/solarized/blob/master/img/… . Первый URL покажет вам интерфейс GitHub и изображение, а второй покажет вам только изображение. Относительные ссылки все еще полезны при клонировании / разветвлении репозиториев, так что да, вы должны использовать относительные пути с этим параметром, но это две разные концепции.
Пол

70

Хотя уже есть принятый ответ, я хотел бы добавить еще один способ загрузки изображений в readme на GitHub.

  • Вы должны создать проблему в своем репо
  • Перетащите в область комментариев ваше изображение
  • После того, как ссылка на изображение сгенерирована, вставьте ее в ваш файл readme.

Более подробную информацию вы можете найти здесь


6
Мне интересно, как долго изображения, загруженные таким образом, будут жить. Github выполняет очистку некоторых изображений? Мол, «если это изображение не ссылаться из любого вопроса GitHub, я могу безопасно удалить его» ...
артинов

1
@ Артин, вероятно, только когда проблема полностью удалена. Закрытые проблемы остаются навсегда, поскольку они играют очень важную роль в документировании и отладке
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 изменит доменное имя и т. Д. И т. Д.)
Линус Уннебекк

7
@ LinusUnnebäck: есть одна веская причина использовать абсолютные пути imho: если readme.md используется и в других местах, например, в качестве главной страницы Doxygen. Относительные ссылки не будут работать тогда.
Ela782

1
@ Ela782 хотя, на дополнительном примечании, что должно не быть проблемой для программного обеспечения , которая копирования файлов README именно из GitHub ; такое программное обеспечение должно знать для правильного разрешения относительных URL-адресов. npm делает , например.
Марк Амери

как сделать ссылку на изображение на raw.github.comподдомене? куда загрузить файл изображения?
Saif

@Saif raw.github.com - это просто отражение того, что передано в ваш репозиторий github. Просто добавьте изображение в свой репозиторий и следуйте указанному формату URL.


21

Одна строка ниже должна быть то, что вы ищете

если ваш файл находится в хранилище

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

если ваш файл находится в другом внешнем URL

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

2
предложить использовать относительную ссылку на файл изображения, см. Относительные ссылки в файле README - Справка Github
shaobin0604

2
-1 по причине, указанной @ shaobin0604; Официальные документы рекомендуют использовать относительные ссылки при ссылке на файл в вашем собственном репо, чтобы ссылка указывала на правильное место при разветвлении.
Марк Амери

17

Синтаксис уценки для отображения изображений действительно:

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

НО: как обеспечить url?

  • Вы, вероятно, не хотите загромождать репо скриншотами, они не имеют ничего общего с кодом
  • Возможно, вам не захочется иметь дело с тем, чтобы сделать ваше изображение доступным в Интернете ... (загрузить его на сервер ...).

Итак ... вы можете использовать этот удивительный трюк, чтобы github размещал ваш файл изображения. TDLR:

  1. создать проблему в списке проблем вашего репо
  2. перетащите свой скриншот по этой проблеме
  3. скопируйте код уценки, который GitHub только что создал для отображения своего изображения
  4. вставьте его в свой файл readme (или куда хотите)

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


7

Гораздо проще, чем добавить URL Просто загрузите изображение в тот же репозиторий, например:

![Screenshot](screenshot.png)



4

Markdown: ![Screenshot](http://url/to/img.png)

  • Создать проблему с добавлением изображений
  • Добавить изображение с помощью перетаскивания или выбора файла
  • Затем скопируйте источник изображения

  • Теперь добавьте ![Screenshot](http://url/to/img.png)в ваш файл README.md

Выполнено!

В качестве альтернативы вы можете использовать какой-нибудь хостинг изображений, например, imgurполучить его URL и добавить его в файл README.md, или вы также можете использовать статический хостинг файлов.

Образец вопроса


Я сделал это давным-давно, сейчас изображения недоступны. Поэтому я не рекомендую это.
Намек

В этом случае вы всегда можете использовать 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 Workspace

Во-вторых, вам нужно добавить ссылку на каждое изображение в ваш 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"/>

Если вы хотите, чтобы каждый снимок экрана находился на отдельной строке, напишите их ссылки на отдельных строках. Тем не менее, лучше, если вы напишите все ссылки в одну строку, разделенные только пробелом. На самом деле это может выглядеть не очень хорошо, но GitHub автоматически организует их для вас.

Наконец, внесите свои изменения и нажмите их!


1

Я погуглил несколько похожих вопросов и не увидел ответов с моей проблемой и ее довольно простым / легким решением.

Облачное хранилище Google - немного другой подход к изображениям в 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. Вам необходимо получить сгенерированный URL-адрес из консоли Google Cloud.

Однако я уверен, что есть более плавный способ, просто зайдите на заданную конечную точку URL и скопируйте длинный URL. Подробности:

инструкции

  1. Посетите консоль хранения: https://console.cloud.google.com/storage/browser/ $ {MY_BUCKET}? Project = $ {MY_PROJECT}
  2. Нажмите на изображение, которое вы хотите отобразить в Github (откроется страница «Сведения об объекте»)
  3. Копировать макароны , что URL (один , начиная с httpsнеgs ) в новую вкладку / окно браузера
  4. Скопируйте новый созданный URL - он должен быть длиннее - из новой вкладки / окна браузера в файл README Github.

Надеюсь, это поможет ускорить и прояснить эту проблему для всех остальных.


К вашему сведению - похоже, что-то меняется на стороне Google или Github. У меня были некоторые изображения в README, сбои этого метода, а некоторые работали по состоянию на полдень 28 марта 2020 года. YMMV здесь!
Джейсон Р. Стивенс CFA

0

Для меня лучший способ -

  1. Создайте новую проблему с этим хранилищем на github, а затем загрузите файл в формате gif. Для преобразования видеофайлов в формат gif вы можете использовать этот веб-сайт 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, которое содержится в вашем ответе, так что спасибо!
Коди Райхерт

Я нашел этот ответ полезным, поскольку он позволяет вам устанавливать размеры изображения
Стэнли
Используя наш сайт, вы подтверждаете, что прочитали и поняли нашу Политику в отношении файлов cookie и Политику конфиденциальности.
Licensed under cc by-sa 3.0 with attribution required.