Как новичку правильно оформить профиль GitHub

oblozhka_profil
И почему это важно для работодателей

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

Зачем оформлять профиль

Начинающему специалисту особенно важно показать пример кода. Например, pet-проект, open-scource проект и пр. Но пустая страница и десяток открытых репозиториев не позволят понять, чем конкретно он занимался, какой опыт получил. Чтобы разобраться, потребуется потратить время и изучить несколько репозиториев, а на просмотр резюме HR-менеджер тратит не более 10 секунд. Если профиль оформлен, все будет понятно с первого взгляда на страницу.

В профиле на GitHub можно разместить контакты, список навыков, код проектов и ссылки на важные ресурсы. Если нет своего сайта, страница сможет его заменить.

gh-1-6296986
Так будет выглядеть профиль, если использовать советы из статьи

Первоначальная настройка профиля

Создание профиля — несложный процесс, который напоминает создание аккаунта в социальной сети. Он будет совершенно пустой. Необходимо заполнить все поля, указать имя, адрес электронной почты для связи и локацию, добавить изображение профиля. Важно, чтобы пользователи сразу видели владельца аккаунта, а не персонажа из популярной игры или фильма.

gh-2-3517616
Профиль с аватаркой и базовой информацией о пользователе

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

Если на платформе создать репозиторий с названием, копирующем никнейм, система сгенерирует шаблон с информацией о пользователе и закрепит его на странице профиля. Важно, чтобы репозиторий был публичным и содержал в себе README-файл. Поэтому при создании надо обратить внимание на эти настройки. Проверяем, убеждаемся, что все так, а затем нажимаем кнопку «Создать репозиторий».

gh-3-2788421
Выделенные настройки нельзя пропускать

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

gh-4-9278526
Базовое оформление, генерируемое GitHub

Файл README.md представляет собой обычный документ с языком разметки Markdown. Для работы с файлом надо познакомиться с основами языка. GitHub также может работать с HTML-разметкой, а иногда в одном документе можно одновременно использовать и HTML, и Markdown.

Список основных элементов Markdown:

screenshot_13-6422464
Элементы Markdown

Файл можно оформить в браузере с помощью встроенного редактора GitHub. Но это не самый удобный вариант: нужно постоянно переключаться между редактором и вкладкой с превью. Ситуацию можно исправить и перейти к локальному редактированию на своем компьютере, а готовый файл загрузить в репозиторий. В таком случае на компьютер надо установить дополнительные инструменты:

  • редактор кода Visual Studio Code, в котором можно писать код разметки;
  • плагин Markdown Preview Github Styling для VS Code, чтобы в режиме реального времени отслеживать изменения на одном экране и в стиле GitHub;
  • плагин Markdown Emoji, чтобы добавить эмодзи.

Шапка страницы

В шапке страницы можно поприветствовать гостей профиля, кратко рассказать о себе и дать ссылки на социальные сети и мессенджеры. Это поможет пользователям быстро понять, чем занимается владелец профиля, как с ним можно связаться.

gh-5-2328586
Шапка страницы

Чтобы выровнять текст по центру страницы, лучше в основном использовать в шапке HTML-разметку.

Сначала нужно создать контейнер div, задать ему ID и сразу выровнять по центру. Внутри блока на первой строке — указать приветствие и свое имя, а на второй — специализацию.

<div id="header" align="center">
	<h1>Hi there, I'm Ivan</h1>
	<h3>Full Stack Developer from New York</h3>
</div>

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

  • LinkedIn — для связи и делового общения;
  • Twitter — для общего представления себя;
  • Telegram — для быстрой личной связи.

Ссылки на социальные сети можно сделать с помощью бейджей с иконками. Для этого подойдет сервис Shield.io. Из него можно получить ссылку на изображение с бейджем и добавить его на страницу с помощью HTML-разметки.

Синтаксис выглядит так:

<a href="linkedin-url">
	<img src="https://img.shields.io/badge/LinkedIn-blue?style=for-the-badge&logo=linkedin&logoColor=white" alt="LinkedIn"/>
</a>

В href необходимо поместить ссылку на свой профиль, в src — ссылку на изображение. Текст в alt будет выводиться, если картинка вдруг не загрузится. Тогда пользователи поймут, что должно быть на изображении.

Ссылки на картинки можно получить на Shield.io или построить самостоятельно. Обычно они состоят из следующих частей:

  • https://img.shields.io/badge/ — основная часть, ее нельзя менять;
  • LinkedIn-blue? — название сервиса и необходимый цвет;
  • style=for-the-badge — стиль изображения (бейдж);
  • logo=linkedin — логотип, который нужно выводить;
  • logoColor=white — цвет логотипа.

Осталось повторить действия для трех бейджей:

<div id="socials" align="center">
	<a href="linkedin-url">
		<img src="https://img.shields.io/badge/LinkedIn-blue?style=for-the-badge&logo=linkedin&logoColor=white" alt="LinkedIn"/>
	</a>
	<a href="twitter-url">
		<img src="https://img.shields.io/badge/Twitter-blue?style=for-the-badge&logo=twitter&logoColor=white" alt="Twitter"/>
	</a>
	<a href="telegram-url">
		<img src="https://img.shields.io/badge/Telegram-blue?style=for-the-badge&logo=telegram&logoColor=white" alt="Telegram"/>
	</a>
</div>

Биография

В следующем блоке нужно кратко рассказать о себе, своей специализации, интересах и планах. Этот раздел можно оформить в свободном стиле, но лучше помнить про структуру и не перегружать деталями. Для примера опишем биографию в виде списка, а для тематического разделения будем использовать эмодзи.

gh-6-9299202
Заполнение биографии

GitHub поддерживает прямую работу с эмодзи. Если они есть в тексте, система поймет это и корректно отобразит на экране. Поэтому можно использовать панель ввода эмодзи на компьютере. Если это невозможно, в GitHub есть специальный синтаксис для выбора эмоций.

Чтобы напечатать эмодзи на экране, необходимо «обернуть» его название двоеточиями. У некоторых эмодзи специфические названия, поэтому их всегда можно подсмотреть в репозитории. Там же есть код для вставки.

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

Код блока:

### About me
- 🌱 I’m currently learning **Web3, GameDev**
- 📝 I regularly write articles on [Medium](medium-link)
- 📄 Know about my experiences [CV](cv-link)
- 📫 Reach me by [LinkedIn](linkedin-link), [email](mailto:email-address)
- 🌍 I speak English

Языки и технологии

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

gh-7-9830253
Список технологий

Ссылки на иконки логотипов можно получить в сервисе Devicon. На сайте хранится большая библиотека логотипов языков программирования, фреймворков, библиотек и инструментов.

Синтаксис вставки изображения:

<img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/javascript/javascript-original.svg" title="js" width="40" height="40"/>&nbsp;

В знакомой конструкции появились новые параметры:

  • в src нужно указать ссылку на изображения; 
  • в title для удобства добавить название инструмента; 
  • в width и height задать ширину и высоту картинки. 

В конце конструкции есть элемент &nbsp. Он нужен для того, чтобы система не переводила каждое изображение на новую строчку и выводила все в одну линию.

Код блока выглядит так:

### Languages and tools
<img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/javascript/javascript-original.svg" title="js" width="40" height="40"/>&nbsp;
<img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/html5/html5-original.svg" title="html" width="40" height="40"/>&nbsp;
<img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/css3/css3-original.svg" title="css" width="40" height="40"/>&nbsp;
<img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/react/react-original.svg" title="react" width="40" height="40"/>&nbsp;
<img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/git/git-plain.svg" title="git" width="40" height="40"/>&nbsp;
<img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/postgresql/postgresql-original.svg" title="sql" width="40" height="40"/>&nbsp;
<img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/angularjs/angularjs-original.svg" title="angular" width="40" height="40"/>&nbsp;
<img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/bootstrap/bootstrap-plain.svg" title="bootstrap" width="40" height="40"/>&nbsp;
<img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/npm/npm-original-wordmark.svg" title="npm" width="40" height="40"/>&nbsp;
<img src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/nodejs/nodejs-original.svg" title="node" width="40" height="40"/>&nbsp;

Статистика

Чтобы показать в последнем блоке статистику использования GitHub, можно использовать виджеты из коллекции GitHub Profile Summary Cards. Они выводят данные об активности пользователя, истории коммитов и языках программирования. Виджеты динамические, поэтому информация на них будет автоматически актуализироваться.

gh-8-5967026
Динамические виджеты

Виджеты можно использовать с помощью Markdown. Для этого достаточно вставить в документ строчку и заменить параметр username на имя пользователя GitHub:

![](https://github-profile-summary-cards.vercel.app/api/cards/stats?username=vn7n24fzkq&theme=github_dark)

Также в ссылке есть параметр theme, позволяющий менять тему виджета. Всего их шестнадцать, а дизайн каждой темы можно посмотреть на сайте.

Если использовать сразу три виджета на странице, способ с разметкой Markdown не подойдет. Виджеты будут находиться друг под другом и займут много места. Для выравнивания можно использовать HTML.

Поместить виджеты на страницу можно с помощью вставки обычного изображения, а в src указать ссылку на виджет:

<img src="https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq&theme=github_dark"/>

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

### My stat
<div id="stat" align="center">
	<img src="https://github-profile-summary-cards.vercel.app/api/cards/profile-details?username=vn7n24fzkq&theme=github_dark"/>
	<img src="https://github-profile-summary-cards.vercel.app/api/cards/most-commit-language?username=vn7n24fzkq&theme=github_dark"/>
	<img src="https://github-profile-summary-cards.vercel.app/api/cards/stats?username=vn7n24fzkq&theme=github_dark"/>
</div>

Код к статье можно найти по ссылке.

Это один из вариантов оформления профиля. Возможности GitHub позволяют реализовать разные идеи. Примеры можно посмотреть в репозитории Awesome GitHub Profile. В нем собраны лучшие профили. Открытый код позволяет использовать задумки на своей странице.

(рейтинг: 5, голосов: 1)
Добавить комментарий