Как добавить картинку в readme github
Перейти к содержимому

Как добавить картинку в readme github

Как добавить изображения в README.md на GitHub?

Недавно я присоединился к GitHub . Я вел там несколько проектов.

Мне нужно включить несколько изображений в мой файл README. Я не знаю, как это сделать.

Я искал об этом, но все, что я получил, это несколько ссылок, которые говорят мне «разместить изображения в Интернете и указать путь к изображению в файле README.md».

Есть ли способ сделать это без размещения изображений на каких-либо сторонних веб-хостингах?

29 ответов

Попробуйте эту уценку:

Я думаю, вы можете напрямую ссылаться на необработанную версию изображения, если оно хранится в вашем репозитории. т.е.

Вы можете ссылаться на изображения в своем проекте с README.md (или извне), используя альтернативную ссылку CDN на github.

URL-адрес будет выглядеть так:

В моем проекте есть изображение SVG, и когда я ссылаюсь на него в документации по проекту Python, оно не отображается.

Ссылка на проект

Вот ссылка проекта на файл (не отображается как изображение):

Пример встроенного изображения:

Необработанная ссылка

Вот ссылка на файл в формате RAW (по-прежнему не отображается как изображение):

Пример встроенного изображения:

CDN ссылка

Используя ссылку CDN, я могу связать файл с помощью (отображается как изображение):

Пример встроенного изображения:

Вот как я могу использовать изображения из моего проекта как в моем файле README.md , так и в документации проекта PyPi reStructredText (здесь)

В моем случае я использую imgur и использую прямую ссылку таким образом.

Обычно я размещаю изображение на сайте, оно может ссылаться на любое размещенное изображение. Просто бросьте это в ридми. Работает для файлов .rst , не уверен насчет .md

В новом интерфейсе Github это работает для меня —

Пример. Зафиксируйте свой image.png в папке (myFolder) и добавьте следующую строку в свой README.md:

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

После добавления изображения вы можете увидеть предварительный просмотр изменений на вкладке «Предварительный просмотр изменений». Здесь вы найдете свое изображение. например, вот так. В моем случае

Папка приложения -> папка src -> основная папка -> папка res -> папка с возможностью рисования -> и внутри папки с возможностью рисования находится файл refrence_image.png. Чтобы добавить несколько изображений, вы можете сделать это следующим образом:

Примечание 1. Убедитесь, что имя файла изображения не содержит пробелов. Если он содержит пробелы, вам нужно добавить% 20 ​​для каждого пробела между именем файла. Лучше убрать пробелы.

Примечание 2 — вы даже можете изменить размер изображения с помощью тегов HTML или другими способами. вы можете погуглить, чтобы узнать больше. если вам это нужно.

После этого напишите сообщение о фиксации изменений, а затем зафиксируйте свои изменения.

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

Используйте таблицы, чтобы выделиться, это придаст ему особый шарм

Разделите каждую ячейку столбца символом |

И заголовок таблицы (первая строка) на второй строке на —


| col 1 | col 2 |
| ———— | ————- |
| изображение 1 | изображение 2 |

enter image description here

Теперь просто поместите <img src=»https://question-it.com/questions/4720607/url/relativePath»> на изображение 1 и изображение 2, если вы используете два изображения

Пример

| col 1 | col 2 |
| ———— | ————- |
| <img src=»https://media.wired.com/photos/5926db217034dc5f91becd6b/master/w_582,c_limit/so-logo-s.jpg» width=»250″> | <img src=»https://mk0jobadderjftub56m0.kinstacdn.com/wp-content/uploads/stackoverflow.com-300.jpg» width=»250″> |

Интервал не имеет значения

Выходное изображение

enter image description here

Просто добавьте тег <img> в ваш README.md с относительным src для вашего репозитория. Если вы не используете относительный src, убедитесь, что сервер поддерживает CORS.

Это работает, потому что GitHub поддерживает inline-html

Обратите внимание на здесь

Базовый синтаксис

  1. my-image-alt-tag: текст, который будет отображаться, если изображение не отображается.
  2. url-to-image: каким бы ни был ваш ресурс изображения. URI изображения

Примере:

Это будет выглядеть так:

stack overflow image by alamin

  • Создать проблему при добавлении изображений
  • Добавьте изображение, перетащив его или выбрав файл

Затем скопируйте источник изображения

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

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

Мне нужно включить несколько изображений в мой файл README. Я не знаю, как это сделать.

Я создал небольшой мастер, который позволяет вам создавать и настраивать простые галереи изображений для файла readme вашего репозитория GitHub: см. ReadmeGalleryCreatorForGitHub >.

Мастер использует тот факт, что GitHub позволяет тегам img размещаться в README.md . Кроме того, мастер использует популярный прием загрузки изображений в GitHub, перетаскивая их в область проблемы (как уже упоминалось в одном из ответов в этой ветке).

enter image description here

Зафиксируйте свое изображение ( image.png ) в папке ( myFolder ) и добавьте следующую строку в свой README.md :

![Optional Text](../master/myFolder/image.png)

Теперь вы можете перетаскивать изображения во время редактирования файла readme.

Github создаст для вас ссылку в формате:

Кроме того, внизу файла написано: «Прикрепите файлы, перетаскивая, выбирая или вставляя их». Если вы нажмете на него, у вас будет возможность загрузить файл напрямую или вы можете просто вставить его!

Есть еще один вариант, о котором я не упоминал. Вы можете просто создать другой репозиторий под своим пользователем или организацией под названием «активы». Отправьте свои изображения в это репо и ссылайтесь на них из других репозиториев:

Я сделал это в одном из моих репозиториев, и это меня вполне устраивает. Я могу создавать версии своих изображений README для всех моих проектов независимо от моего кода, но все же хранить их все в одном месте. Никаких проблем, веток или других артефактов, которые легко потерять, не требуется.

Рассмотрите возможность использования table , если добавляете несколько снимков экрана и хотите выровнять их с использованием табличных данных для улучшения доступности, как показано здесь:

high-tea

Если ваш анализатор уценки поддерживает это, вы также можете добавить атрибут role=»presentation» WIA-ARIA к элементу TABLE и опустить теги th .

САМЫЙ ПОСЛЕДНИЙ

Вики могут отображать изображения PNG, JPEG или GIF.

Теперь вы можете использовать:

Следуй этим шагам:

На GitHub перейдите на главную страницу репозитория.

Под именем вашего репозитория нажмите Wiki.

Используя боковую панель вики, перейдите на страницу, которую вы хотите изменить, и нажмите «Изменить».

На панели инструментов вики нажмите Изображение .

В диалоговом окне «Вставить изображение» введите URL-адрес изображения и замещающий текст (который используется поисковыми системами и программами чтения с экрана).

Я нашел другое решение, но совсем другое, и я объясню его

По сути, я использовал тег, чтобы показать изображение, но я хотел перейти на другую страницу, когда по изображению щелкнули, и вот как я это сделал.

Если вы поместите их рядом друг с другом, разделив их новой строкой, я думаю, когда вы нажмете на изображение, он перейдет к тегу с href на другой сайт, который вы хотите перенаправить.

Я просто расширяю или добавляю пример к уже принятому ответу.

После того, как вы разместите изображение в репозитории Github.

  • Откройте соответствующее репозиторий Github в своем браузере.
  • Перейдите к целевому файлу изображения. Затем просто откройте изображение в новой вкладке.
  • Скопируйте URL
  • И, наконец, вставьте URL в следующий шаблон ![alt text](https://raw.githubusercontent.com/username/projectname/branch/path/to/img.png)

В моем случае это

![In a single picture](https://raw.githubusercontent.com/shadmazumder/Xcode/master/InOnePicture.png)

  • shadmazumder мой username
  • Xcode — это projectname
  • master — это branch
  • InOnePicture.png — это image , в моем случае InOnePicture.png находится в корневом каталоге.

Если вам нужно загрузить несколько изображений для документации, хорошим подходом будет использование git-lfs. Предполагая, что вы установили git-lfs, выполните следующие действия:

Инициализируйте git lfs для каждого типа изображения:

Создайте папку, которая будет использоваться в качестве местоположения изображения, например. doc . В системах на базе GNU / Linux и Unix это можно сделать с помощью:

Скопируйте и вставьте любые изображения в папку с документами. Затем добавьте их с помощью команды git add .

Зафиксируйте и нажмите.

Изображения общедоступны по следующему адресу:

https://media.githubusercontent.com/media/ ^ github_username ^ / ^ repo ^ / ^ ветка ^ / ^ image_location в репо ^

Где: * ^github_username^ — имя пользователя в github (его можно найти на странице профиля) * ^repo_name^ — имя репозитория * ^branch^ — ветка репозитория, куда загружается изображение * ^image_location in the repo^ — это место, включая папку, в которой хранится изображение.

Также вы можете сначала загрузить изображение, затем посетить место на странице github вашего проекта и перемещаться по нему, пока не найдете изображение, затем нажмите кнопку download , а затем скопируйте и вставьте URL-адрес из адресной строки браузера.

Посмотрите это из моего проекта как Справка.

Затем вы можете использовать URL-адрес, чтобы включить их, используя синтаксис уценки, упомянутый выше:

Например: допустим, мы используем this фото Тогда вы можете использовать синтаксис уценки:

В моем случае я хотел показать экран печати на Github , но также и на NPM . Несмотря на то, что использование относительного пути работало внутри Github , оно не работало вне его. По сути, даже если я перенес свой проект в NPM (который просто использует тот же readme.md ), изображение никогда не показывалось.

Я пробовал несколько способов, в конце концов, у меня сработало следующее:

Теперь я правильно вижу свое изображение на NPM или в любом другом месте, где я мог бы опубликовать свой пакет.

Есть два простых способа сделать это:

1) используйте тег HTML img,

2)! [] (Путь, по которому сохраняется ваше изображение / image-name.png)

Путь, который вы можете скопировать из URL-адреса в браузере, когда вы открыли это изображение. может возникнуть проблема с интервалом, поэтому убедитесь, что есть пробел между двумя словами пути или в имени изображения add->% 20. точно так же, как это делает браузер.

GitHub Markdown: Add an Image to README.md File

Happy Christmas Image.

In GitHub, you can add an image to a README.md file in three ways. First, by referencing the existing image file that exists in your GitHub repository, second, by uploading a new image file to your repository and reference it in the README.md file and the third is by referencing an external image file. In this tutorial, I am giving examples of all these three ways to show you, how to add an image to the README.md file in GitHub. But first of all, you should know the syntax to specify an image file in the README.md or in any document in the GitHub.

GitHub Image Markdown Syntax

It starts with an exclamation mark, then square brackets where you can specify the alt text for SEO and then the image file URL in parenthesis.

1. Add an existing Image to README.md file

In the following example, we will add an image file that already exists in our repository. Below is the screenshot of the image folder contents in repository markdown-demo :

GitHub Repository image folder contents.

Here you can see, that we have the image file named github-logo.png in folder images of the markdown-demo repository. Now we can add this image in our README.md file as shown in the below example:

After editing the README.md file, Commit the changes. The output would be as shown in the below image:

Output:

Example-1: add image to readme.md in GitHub.

2. Add an Image by Uploading a New Image File to Repository

In this example, we will upload a new image file in our repository markdown-demo and then we will add it to the README.md file. Follow these steps:

Upload a New Image File to Your Repository

In your repository root directory or in any existing folder, click on the Upload Files button as shown in the image below:

Upload an image in GitHub repository.

Then in the next step, you can browse or drag and drop a particular image or multiple images or any folder containing the images, as shown in the below screenshot:

Добавить комментарий

Ваш адрес email не будет опубликован. Обязательные поля помечены *