Як додати скріншот до README у сховищі github?


594

Чи можливо розмістити скріншот у файлі README у сховищі GitHub? Що таке синтаксис?


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

2
Більшість рішень пропонують вказати на саму репо. Що робити, якщо ви хочете уникнути бінарних файлів у репо (навіть у відокремленій гілці, як запропоновано), і хочете зберігати їх у зовнішньому місці? Якісь добрі практики? Можливо, суть (IDK, якщо суть може бути двійковою чи просто текстовою)? створення ще одного репо "myproject-активи" для проекту "myproject"? Будь-яке зовнішнє популярне місце для зображень, подібне до де-факто стандарту YouTube для завантаження відео?
Хаві Монтеро


Відповіді:


850

Якщо ви використовуєте 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
Тарраш

4
github.com/altercation/solarized - це надана версія наведеного вище прикладу, якщо це допомагає комусь.
barrycarter

3
Коли ви говорите /relative/path/to/img.jpg, чи не абсолютний шлях через провідну косу рису?
jww

1
@kelvin, raw=trueпараметр є для того, щоб відобразити зображення, на яке вказує шлях GitHub, а не інтерфейс GitHub. Спробуйте і побачите різницю: github.com/altercation/solarized/blob/master/img/… vs github.com/altercation/solarized/blob/master/img/… . Перша URL-адреса покаже вам інтерфейс GitHub та зображення, а друга - лише зображення. Відносні посилання все ще корисні при клонуванні / форкінгу репостів, тому так, ви повинні використовувати відносні шляхи з цим параметром, але вони є двома різними поняттями.
Павло

70

Хоча вже є прийнята відповідь, я хотів би додати інший спосіб завантаження зображень у readme на GitHub.

  • Вам потрібно створити випуск у вашому РЕПО
  • Перетягніть зображення в області коментарів
  • Після створення посилання на зображення вставте його у свою програму readme

Більш детальну інформацію ви можете знайти тут


6
Мене цікавить, як довго житимуть завантажені таким чином зображення. Чи виконує чистка зображень github? Мовляв, "якщо на це зображення не посилається жодна проблема github, я сміливо можу його видалити" ...
artin

1
@Artin, ймовірно, лише тоді, коли проблему буде видалено повністю. Закриті питання
залишаються

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 змінює доменне ім’я, тощо. Тощо)
Linus Unnebäck

7
@ LinusUnnebäck: Є одна вагома причина використовувати абсолютні шляхи imho: Якщо readme.md використовується і в інших місцях, наприклад, як головна сторінка Doxygen. Відносні посилання тоді не працюватимуть.
Ela782

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

як пов’язати зображення на raw.github.comпіддомені? куди завантажити файл зображення?
Сайф

@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

Відмітка: ![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

По-друге, вам потрібно додати посилання на кожне зображення до вашої 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 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. Потрібно отримати згенерований 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-адресою - вона повинна бути довшою - із нової вкладки / вікна веб-переглядача у ваш файл Github README

Сподіваємось, це допомагає пришвидшити та прояснити цю проблему для інших.


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

0

Для мене найкращий спосіб -

  1. Створіть нову проблему з цим сховищем на github, а потім завантажте файл у форматі gif. Для перетворення відеофайлів у формат gif ви можете використовувати цей веб-сайт http://www.online-convert.com/
  2. Надішліть щойно створений випуск.
  3. Скопіюйте адресу завантаженого файлу
  4. Нарешті, у вашому файлі README поставлено! [Demo] (КОПІРОВАНА АДРЕСА)

Сподіваюсь, це допоможе.


Чим він відрізняється від stackoverflow.com/a/32252663/1570104 ?
еделани

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
За все життя я не міг зрозуміти, як зосередити зображення в ПРОЧИТАННІ - яке містить Ваша відповідь, тож дякую!
Коді Рейхерт

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