GitHub Readme Stats

GitHub Readme Stats 是一个方便的工具，它可以帮助程序员快速生成展示自己项目信息的 README 文件，并且可自定义其外观和功能。使用该工具可以极大地提升项目的可视性和吸引力。

特点

• 可以生成项目基本信息，如 stars，forks，contributors 等；
• 可以自定义卡片样式和主题颜色，以适配不同的项目风格；
• 可以展示项目语言分布、每个贡献者的贡献量、最近的提交等；
• 可以自动生成徽章，如 Travis CI、Codecov、CodeClimate 等。

怎么使用

1. 在 README 文件顶部加上以下代码片段即可，其中 username 和 repo 分别为你的 GitHub 用户名和项目名称，具体可参考下文中的示例。

   ![Github stats](https://github-readme-stats.vercel.app/api?username=username&show_icons=true&hide_border=true)
   

2. 如果想要展示更多的信息，可以使用以下代码片段代替上面的代码，包含了额外的卡片选项，如 langs_count，theme 等。

   ![Github stats](https://github-readme-stats.vercel.app/api?username=username&show_icons=true&hide_border=true&count_private=true&include_all_commits=true&hide=stars,prs,issues,contribs&langs_count=5&theme=tokyonight)
   

3. 如果想要展示每个贡献者的贡献量，可以使用以下代码片段，其中 layout 指定了卡片样式，title 指定了卡片标题，card_width 指定了卡片宽度。

   ![Contributors](https://github-readme-stats.vercel.app/api/top-langs/?username=username&layout=compact&title_color=fff&text_color=9f9f9f&card_width=450)
   

示例

以下是一个示例，展示了如何在 README 中使用 GitHub Readme Stats。

# My Project
This is a project about ...

## Project Status

[![Github stats](https://github-readme-stats.vercel.app/api?username=myusername&show_icons=true&hide_border=true&count_private=true&include_all_commits=true&hide=stars,prs,issues,contribs&langs_count=5&theme=tokyonight)](https://github.com/myusername/myproject)

## Installation

You can install the project by running ...

## Usage

You can run the project by executing ...

## Contributors

[![Contributors](https://github-readme-stats.vercel.app/api/top-langs/?username=myusername&layout=compact&title_color=fff&text_color=9f9f9f&card_width=450)](https://github.com/myusername/myproject/graphs/contributors)

在 README 文件中插入以上代码即可生成 GitHub Readme Stats 卡片，样式如下所示。