github-readme-stats/readme.md

55 lines
1.4 KiB
Markdown
Raw Normal View History

2020-07-09 18:38:21 +08:00
## Github Readme stats
Get dynamically generated github stats on your readmes!
## How to use
Copy paste this into your markdown content and thats it. simple!
change the `?username=` value to your GitHubs's username
```md
![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra)
```
### Hiding certain stats
To hide any specific stats you can pass a query parameter `?hide=` with an array of items you wanna hide.
> Options: `&hide=["stars","prs","issues","contribs"]`
```md
![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=["contribs","prs"])
```
2020-07-09 21:16:41 +08:00
### Showing icons
To enable icons you can pass `show_icons=true` in the query param like so
```md
![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true)
```
2020-07-09 23:04:10 +08:00
Other options:
- `&hide_border=true` hide the border box if you don't like it :D.
- `&line_height=30` control the line-height between text.
2020-07-09 23:04:10 +08:00
2020-07-09 18:38:21 +08:00
## Demo
2020-07-09 21:16:41 +08:00
- Default
2020-07-09 18:38:21 +08:00
![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra)
- Hiding specific stats
![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=["contribs","issues"])
2020-07-09 21:16:41 +08:00
- Showing icons
![Anurag's github stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&hide=["issues"]&show_icons=true)
2020-07-09 18:38:21 +08:00
Contributions are welcomed! <3
Made with :heart: and javascript.