Чи можливо розмістити скріншот у файлі README у сховищі GitHub? Що таке синтаксис?
Чи можливо розмістити скріншот у файлі README у сховищі GitHub? Що таке синтаксис?
Відповіді:
Якщо ви використовуєте 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")
/relative/path/to/img.jpg
, чи не абсолютний шлях через провідну косу рису?
raw=true
параметр є для того, щоб відобразити зображення, на яке вказує шлях GitHub, а не інтерфейс GitHub. Спробуйте і побачите різницю: github.com/altercation/solarized/blob/master/img/… vs github.com/altercation/solarized/blob/master/img/… . Перша URL-адреса покаже вам інтерфейс GitHub та зображення, а друга - лише зображення. Відносні посилання все ще корисні при клонуванні / форкінгу репостів, тому так, ви повинні використовувати відносні шляхи з цим параметром, але вони є двома різними поняттями.
Хоча вже є прийнята відповідь, я хотів би додати інший спосіб завантаження зображень у readme на GitHub.
Більш детальну інформацію ви можете знайти тут
Я виявив, що шляху до зображення в моєму репо не вистачає, мені довелося посилання на зображення на raw.github.com
субдомені.
Формат URL https://raw.github.com/{USERNAME}/{REPOSITORY}/{BRANCH}/{PATH}
Приклад розмітки ![Settings Window](https://raw.github.com/ryanmaxwell/iArrived/master/Screenshots/Settings.png)
raw.github.com
піддомені? куди завантажити файл зображення?
Один рядок нижче повинен бути тим, що ви шукаєте
якщо ваш файл знаходиться в сховищі
![ScreenShot](https://raw.github.com/{username}/{repository}/{branch}/{path})
якщо ваш файл знаходиться в іншій зовнішній URL-адресі
![ScreenShot](https://{url})
Синтаксис розмітки для відображення зображень насправді:
![image](https://{url})
АЛЕ: Як надати url
?
Отже ... ви можете використовувати цей дивовижний трюк, щоб зробити github хостом вашого файлу зображень. TDLR:
http://solutionoptimist.com/2013/12/28/awesome-github-tricks/
Набагато простіше, ніж додавати URL. Просто завантажте зображення в той же сховище, як:
![Screenshot](screenshot.png)
додайте це до README
<div align="center">
<img src="/screenshots/screen1.jpg" width="400px"</img>
</div>
Відмітка: ![Screenshot](http://url/to/img.png)
Потім скопіюйте джерело зображення
Тепер додайте ![Screenshot](http://url/to/img.png)
у свій файл README.md
Готово!
Крім того, ви можете використовувати якийсь веб-сайт хостингу зображень, наприклад, imgur
отримати його URL та додати його у файл README.md, або ви також можете використовувати хостинг статичних файлів.
Спосіб 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 " />
Примітка -> Якщо ви не хочете стилізувати зображення, тобто змінити розмір, видаліть частину стилю
По-перше, створіть у корені локального репортажу каталог (папку), який буде містити 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 автоматично організовує їх для вас.
Нарешті, введіть свої зміни та натисніть!
Я гуглив кілька подібних питань і не побачив відповіді на свою проблему та її досить просте / легке рішення.
Ось так: як і OP, я хотів зображення в моєму Github README і, знаючи синтаксис Markdown для цього, набрав його:
![My Image](https://storage.cloud.google.com/${MY_BUCKET}/${MY_IMAGE}
Для цього потрібно виконати фактичні заміни (наприклад, MY_IMAGE = image.jpg), щоб це працювало.
Але зачекайте ... невдача - фактично не винесена фотографія! І посилання точно така, як дана в Google Storage!
camo
- анонімні зображенняGithub розміщує ваші зображення анонімно , так! Однак це є проблемою для ресурсів пам’яті Google. Потрібно отримати згенерований URL-адресу з консолі Google Cloud.
Я впевнений, що є більш гладкий спосіб, проте просто відвідайте задану кінцеву точку URL-адреси та скопіюйте довгу URL-адресу. Деталі:
https
не gs
) на нову вкладку / вікно браузераСподіваємось, це допомагає пришвидшити та прояснити цю проблему для інших.
Для мене найкращий спосіб -
Сподіваюсь, це допоможе.
Додайте зображення у сховище з параметра файлу завантаження, а потім у файл README
![Alt text]("enter image url of repositoryhere")
З зображеннями, розташованими в /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>
[Read more words!](docs/more_words.md)