Генератор README профиля GitHub

Результаты

Если создать репозиторий с именем, совпадающим с вашим именем пользователя в GitHub, вы получите README, который отображается в верхней части страницы профиля. Этот генератор создаёт аккуратный файл в формате Markdown для такого репозитория: заголовок, краткое описание, стек технологий и (по желанию) карточки статистики, работающие на основе github-readme-stats.

Как собрать README профиля

  1. 1

    Заполните свои данные

    Отображаемое имя, слоган, местоположение, над чем вы работаете и что изучаете.

  2. 2

    Добавьте свой стек технологий

    Список через запятую; каждый элемент выводится в виде жирного чипа.

  3. 3

    Включите карточки статистики

    Карточки GitHub Stats и Top Languages отображаются в реальном времени на основе github-readme-stats; опция активности добавляет ссылку на ваш график вклада.

  4. 4

    Скопируйте Markdown

    Создайте репозиторий с именем, совпадающим с вашим именем пользователя, и разместите README.md в корне.

Как работает «особый репозиторий»

Если ваше имя пользователя, alex, и вы создали публичный репозиторий с именем alex, GitHub отображает README.md этого репозитория в вашем профиле (над разделом «Популярные репозитории»). Это документированная функция, а не хак.

Карточки, которые может встроить генератор

Карточка URL источника Примечания
Статистика GitHub github-readme-stats-one-bice.vercel.app/api?username=...&show_icons=true Коммиты, PR, issue
Основные языки github-readme-stats-one-bice.vercel.app/api/top-langs/?username=... Распределение языков по размеру репозитория
Активность вклада github.com/{username}?tab=overview Ссылка, которая появляется при включённой опции «Streak»

Обе карточки статистики являются эндпоинтами в формате PNG и отображаются в любом просмотрщике Markdown, в том числе когда кто-то открывает ваш профиль без авторизации; ссылка активности открывает ваш график вклада на GitHub.

Содержимое, которое хорошо читается

  • Слоган в одну строку: роль + направление («Инженер инфраструктуры на Rust, интересуюсь трейсингом»).
  • Не более 3–5 пунктов над стеком; больше, и это выглядит как выгрузка резюме.
  • Навыки в виде чипов, а не абзацем. Читатели ищут технологии беглым взглядом.
  • Ссылки на проекты, которые вы действительно поддерживаете. Заброшенные репозитории, закреплённые в профиле, хуже, чем их отсутствие.
  • Строка контактов: email или один аккаунт в соцсети; не перечисляйте шесть сетей.

Чего туда лучше не добавлять

  • Личные адреса или номера телефонов.
  • Текст для рекрутёров («Open to work», это для LinkedIn или для баннера в GitHub).
  • Эмодзи в каждой строке, один-два уместны, а джунгли из них превращаются в шум.

Часто задаваемые вопросы

github-readme-stats размещён на Vercel и иногда ограничивает частоту запросов или кэширует устаревшие данные. Если карточка не работает, подождите несколько минут или разверните проект у себя, в репозитории есть кнопка развёртывания на Vercel в один клик.

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

Да. GitHub допускает подмножество HTML в Markdown, <img>, <details>, <sub>, <sup> и простые инлайновые стили. Скрипты и формы удаляются из соображений безопасности.

Нет. Введённые вами значения отправляются на наш сервер для создания предпросмотра, а в многошаговом режиме переносятся в ссылке страницы между шагами. Ничего не сохраняется в базе данных и всё удаляется при закрытии вкладки.

Сопутствующие инструменты

Справочная таблица ASCII

Полная таблица ASCII от 0 до 127 с десятичным, шестнадцатеричным, восьмеричным и двоичным представлением, а также записью числовых ссылок HTML, включая NUL, LF и DEL.

Справочник сочетаний клавиш

Ищите документированные сочетания по умолчанию для VS Code, Chrome и Bash с GNU Readline в macOS, Windows и Linux.

Справочник символов HTML

Справочник HTML-сущностей с поиском, их именованными и числовыми кодами, а также копированием специальных символов и знаков одним кликом.

Шпаргалка по Markdown

Практический справочник Markdown с настоящим предпросмотром и готовыми для копирования примерами заголовков, списков, таблиц, кода, ссылок, изображений и синтаксиса GFM.

Счетчик FPS

Измерьте FPS браузера через requestAnimationFrame: сглаживание, минимальная и максимальная частота кадров, порог предупреждения и график по желанию. Работает локально, без загрузок и API.

Генератор EditorConfig

Создайте файл .editorconfig с вашими правилами стиля и размера отступа, конца строки, кодировки и пробелов для единообразного форматирования во всех IDE и редакторах.

Инструмент доступен на других языках