В июле 2020 года GitHub выпустил новую фичу, позволяющую пользователям создавать README для своего профиля, чтобы сделать его более интересным и привлекательным.
Вы можете добавить какую-то личную информацию о себе, например, указать проекты, в которых вы были контрибьютором. Или можно рассказать о своих увлечениях, если думаете, что посетителям это будет любопытно.
Если вам нужен шаблон README — можете взять у меня в профиле.
Как создать README для профиля на GitHub?
Для этого нужно добавить файл README в корень публичного репозитория, название которого совпадает с вашим username. В таком случае README автоматически появится на странице вашего профиля.
Вы увидите красивый баннер, показывающий, что вы обнаружили секрет на GitHub.
Это и все? Да! Это все, что нужно сделать, чтобы добавить README к своему профилю.
Примечание: соглашение о нейминге предусматривает чувствительность к регистру, так что следите за тем, чтобы имена репозитория и файла действительно совпадали.
Что это мне даст?
Когда вы создаете свой репозиторий, создается и README-файл. при этом используется следующий шаблон:
**pedes/pedes** is a ✨ _special_ ✨ repository because of its README.md (this file) appears on your GitHub profile.` Here are some ideas to get you started: - 🔭 I’m currently working on ...` - 🌱 I’m currently learning ... - 👯 I’m looking to collaborate on ... - 🤔 I’m looking for help with ... - 💬 Ask me about ... - 📫 How to reach me: ... - 😄 Pronouns: ... - ⚡ Fun fact: ...
Как сделать README привлекательным?
А вот тут начинается самое интересное. Markdown поддерживает разные элементы, включая эмодзи, GIF, картинки, таблицы и т. п., а все это позволяет создать потрясающий дизайн.
Я собрал список ресурсов, которые помогут вам создать отличный профиль.
Markdown Cheat Sheet
Здесь вы сможете познакомиться с основами Markdown. Это поможет вам понять, как в принципе можно воспользоваться преимуществами этой разметки в своем README.
Simple Icons
Включите в свой README значки самых показательных проектов, над которыми работали, и инструментов, которыми пользуетесь.
GitHub README Profile Creator
Простой и легкий способ создания README для вашего профиля при помощи инструмента с открытым исходным кодом.
Значки для разметки Markdown
Счетчик просмотров GitHub-профиля
Генератор README для GitHub-профиля
GitHub Readme Stats
Вывод статистики профиля.
Shields
Бейджики и значки соцсетей.
Вам нужно вдохновение?
Вот подборка интересных README, способных вдохновить вас на создание собственного:
Kat Fukui
Monica Powell
Martin Heinz
Thomas Guibert
[customscript]techrocks_custom_after_post_html[/customscript]
[customscript]techrocks_custom_script[/customscript]