Skip to content

Instantly share code, notes, and snippets.

@chrisryana
Last active October 10, 2024 21:36
Show Gist options
  • Save chrisryana/b2657506eeb489867f3e47343588343e to your computer and use it in GitHub Desktop.
Save chrisryana/b2657506eeb489867f3e47343588343e to your computer and use it in GitHub Desktop.
Добавление изображений в readme

📝Вставка изображений в Readme.md

В этом кратком руководстве вы узнаете, как создать отдельную ветку в своем репозитории для размещения скриншотов и демонстрационных картинок для использования в файле Readme.md master-ветки.

1. Клонируйте репозиторий

Чтобы предотвратить любую потерю работы, лучше всего клонировать репозиторий в отдельном месте для выполнения этой задачи.

2. Создайте новую ветку

Создайте новую ветку в репозитории, используя в терминале команду git checkout --orphan assets

Это создаст и переключит вас на новую ветку под названием "assets". Флаг --orphan создает новую ветку пустой, без привязки к родительской ветке. В ней не будет коммитов. Однако она сохранит рабочее дерево.

3. Удалите все файлы из дерева

git rm -rf .

Важно: обязательно убедитесь что находитесь в нужной ветке "assets" с помощью команды git branch

Обратите внимание на точку в конце. Это часть команды, означающая, что нужно удалить все файлы.

4. Добавьте свои изображения и передайте изменения

Переместите в папку проекта все необходимые файлы и введите в терминал команду git add .. Теперь можно закоммитить изменения: git commit -m "Добавлены демонстрации".

5. Отправьте изменения в удаленный репозиторий

git push origin assets

6. Используйте изображения в Readme

Теперь вы можете использовать ссылку ![alt text](https://raw.githubusercontent.com/username/projectname/commit/img.png) в вашем readme.

  • alt text – любой текст описывающий изображение. Лучше указать, тк если указана неверная ссылка, будет легко обнаружить это.
  • username – логин на гитхаб
  • projectname – название репозитория
  • commit – уникальный hash коммита. Чтобы его узнать нужно ввести в терминал команду git log и скопировать безобразно длинную строку из букв и цифр.
  • img.png – имя файла изображения

7. Удалите ветку

Проверьте, что все изображения корректно отображаются в Readme. Если изображения нет, но и иконка поврежденного файла не отображается - все нормально. Значит файл достаточно большой и еще не загрузился. У меня такое было и занимало до 5-7 минут.

Теперь можно удалить ветку git push origin --delete assets

Все изображения должны отображаться💃

@akkullow
Copy link

demo25_mod1_topology

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment