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…

这是什么?这是一个 GitHub 个人主页 README 生成器:填写一份简短的表单,它就会生成包含热门插件的 markdown,直接粘贴到你的个人主页仓库就能用。
这是需要安装的软件,还是直接打开的网站?它是一个网页应用——在线演示直接在浏览器里打开,不用安装。源代码也是公开的,你也可以自己跑一份:克隆仓库、安装依赖、启动 Next.js 应用。
我怎么从空白表单做到一份完成的个人主页 README?在这个极简界面里填写 Name、Tagline、各开发平台用户名、Current Work、Portfolio 和 Blog 等字段,点击 Generate README,然后预览生成的 markdown,再复制到你的个人主页仓库。
有没有插件需要我在 GitHub 仓库里额外设置?博客类插件以 GitHub Actions 的形式提供,需要在你的个人主页仓库里配置,这样文章会自动拉取进来;统计徽章则由 github-readme-stats 这类外部服务渲染。
有什么需要注意的坑吗,比如用在商业项目上?README 里提到了字体授权问题:Wotfard 字体是按开源场景下的合理使用(fair use)来使用的,如果你想把这个项目用于商业用途,需要自行核实该字体的授权要求。
我使用这个网站时会被追踪吗?它使用注重隐私的统计分析:Google Analytics 4 并符合 GDPR 要求征得同意、对 IP 做匿名化处理,还提供可退出选项的 cookie 横幅,不收集个人数据——只记录匿名使用情况。
它能在我的个人主页上放哪些东西?统一的开发者和社交图标、访客计数徽章、GitHub 个人统计卡片、最常用技能、连击(streak)统计、WakaTime 统计、Buy Me a Coffee 按钮,以及来自 dev.to、Medium 或任意 RSS 源的动态博客列表。
作者为什么要做这个?手动编辑个人主页 README 来跟上新功能实在太麻烦;这个生成器把最新的插件——访客统计、GitHub 统计等等——打包进一个简单的表单里。
它免费吗?开源吗?是的——代码采用 Apache-2.0 许可证,在线生成器免费使用,项目还通过赞助板块接受捐助。它也是一个欢迎 hacktoberfest 贡献的仓库。
它是用什么做的?Next.js 15(App Router)、TypeScript、Tailwind CSS、Framer Motion、Lucide React 图标,表单处理用的是 React Hook Form。
Size
18.1 MB
Stars
24.5K
Age
6y
Commits · 90 Days