github-profile-readme-generator README

The project's README from github.com/rahuldkjain/github-profile-readme-generator. As one markdown file: README.md.

GitHub Profile Readme Generator

GitHub Profile README Generator

github-profile-readme-generator license github-profile-readme-generator forks github-profile-readme-generator stars github-profile-readme-generator issues github-profile-readme-generator pull-requests join discord community of github profile readme generator

github-profile-readme-generator gif

View Demo · Report Bug · Request Feature

Loved the tool? Please consider donating 💸 to help it improve!

sponsor github profile readme generator Buy Coffee for rahuldkjain Buy Me A Coffee

Tired of editing GitHub Profile README with new features?

This tool provides an easy way to create a GitHub profile readme with the latest add-ons such as visitors count, github stats, etc.

🚀 Demo

Try the tool: GitHub Profile README Generator

🧐 Features

Just fill in the details such as Name, Tagline, Dev Platforms Username, Current Work, Portfolio, Blog, etc. with a minimal UI.

Click on Generate README to get your README in markdown. You can preview the README too.

🛠️ Installation Steps

  1. Clone the repository
git clone https://github.com/rahuldkjain/github-profile-readme-generator.git
  1. Change the working directory
cd github-profile-readme-generator
  1. Install dependencies
npm install
  1. Run the app
npm run dev

🌟 You are all set!

🍰 Contributing

Please contribute using GitHub Flow. Create a branch, add commits, and open a pull request.

Please read CONTRIBUTING for details on our CODE OF CONDUCT, and the process for submitting pull requests to us.

💻 Built with

🙇 Special Thanks

🙇 Sponsors

🔒 Privacy & Analytics

This tool includes privacy-friendly analytics to help improve the user experience:

📄 Font Licensing

This project uses the Wotfard font family:

For commercial use of this project, please verify font licensing requirements.

🙏 Support

sponsor github profile readme generator tweet github profile readme generator

Buy Coffee for rahuldkjain Buy Me A Coffee

🌟 Star History

GPRG Star History Chart

Developed with ❤️ in India 🇮🇳

github-profile-readme-generator (rahuldkjain/github-profile-readme-generator)

Searching Database…

Что это такое?Это генератор README для профиля GitHub: вы заполняете короткую форму, и он создаёт markdown с популярными дополнениями, готовый для вставки в репозиторий вашего профиля.
Это что-то, что я устанавливаю, или сайт, который просто открываю?Это веб-приложение — демо открывается прямо в браузере, устанавливать ничего не нужно. А поскольку исходники открыты, вы можете запустить и свою копию: клонировать репозиторий, установить зависимости и запустить приложение на Next.js.
Как мне пройти путь от пустой формы до готового README для профиля?Заполните в минималистичном интерфейсе поля вроде Name, Tagline, никнеймов на дев-платформах, Current Work, Portfolio и Blog, нажмите Generate README, а затем посмотрите предпросмотр markdown, прежде чем копировать его в репозиторий профиля.
Каким-то дополнениям нужна дополнительная настройка в моём репозитории на GitHub?Дополнения для блога поставляются в виде GitHub Actions, которые вы настраиваете в репозитории профиля, и тогда посты подтягиваются автоматически; бейджи со статистикой отрисовывают внешние сервисы вроде github-readme-stats.
Есть ли подводные камни, например использование в коммерческих проектах?README предупреждает о лицензировании шрифта: шрифт Wotfard используется по заявленному принципу добросовестного использования (fair use) для open source, а для коммерческого использования проекта вам стоит самостоятельно проверить требования к лицензии шрифта.
Сайт отслеживает меня, пока я им пользуюсь?Здесь используется аналитика с заботой о приватности: Google Analytics 4 с GDPR-совместимым запросом согласия и анонимизацией IP, баннер про cookie с возможностью отказа, и никаких личных данных не собирается — только анонимные паттерны использования.
Какие дополнения он может добавить на мой профиль?Единые иконки дев-платформ и соцсетей, бейдж со счётчиком посетителей, карточка со статистикой профиля GitHub, топ навыков, статистика стриков, статистика WakaTime, кнопка Buy Me a Coffee и динамические списки постов из блогов dev.to, Medium или любого RSS-фида.
Зачем автор это сделал?Вручную редактировать README профиля, чтобы не отставать от новых фич, быстро надоедает; генератор заворачивает самые свежие дополнения — счётчик посетителей, статистику GitHub и не только — в простую форму.
Это бесплатно и с открытым кодом?Да — код под лицензией Apache-2.0, генератором можно пользоваться бесплатно, а проект принимает пожертвования через раздел спонсоров. Это ещё и репозиторий, дружелюбный к hacktoberfest.
На чём он сделан?Next.js 15 с App Router, TypeScript, Tailwind CSS, иконки Lucide React, анимации Framer Motion и React Hook Form для работы с формой.
Size
18.1 MB
Stars
24.5K
Age
6y
Commits · 90 Days