GitHub Readme Profile

Generate your Stats GitHub Profile in SVG.

Parameters

Click to show/close parameters

Name	Type	Required	Default	Description	More Description
username	string	true		Username registered in GitHub.	Example: FajarKim.
title_color	string		2f80ed	Card's title color	Format: HEX e.g. FF0000.
text_color	string		434d58	Body text color	Format: HEX e.g. FF0000.
icon_color	string		4c71f2	Icons color	Format: HEX e.g. FF0000.
border_color	string		e4e2e2	Card's border color	Format: HEX e.g. FF0000.Does not apply when hide_border is enabled.
bg_color	string		fffefe	Card's background color.	Format: HEX, gradient(angle,start,end) e.g. FF0000, 30,E96443,904E95.
stroke_color	string		e4e2e2	Profile image border color	Format: HEX e.g. FF0000. Does not apply when hide_stroke is enabled.
username_color	string		434d58	Username text color	Format: HEX e.g. FF0000.
theme	string		default	Name of the theme, choose from all available themes	Supported: default, transparent, dark or highcontrast.
title	string			Custom title text for the card	Before use, encode the text to URL format using a tool like URL Encoder.
locate	string		en	Locate (language)	Supported: en, ar, fr, id, ja or ko.
border_width	number		1	Sets the border's width manually
border_radius	number		4.5	Corner rounding on the card
hide	string			Hides the specified items from stats	Example: &hide=repos,stars,forks,commits,prs,prs_merged,issues,contributed.
show	string			Shows additional items on stats card	Example: &show=reviews,issues_closed,discussions_started,discussions_answered.
format	string		svg	输出格式卡片选项	Supported: svg, png, json, or xml.
disabled_animations	boolean		false	Disables all animations in the card	Supported:false or true.
hide_border	string		false	Hides the card's border	Supported: false or true.
hide_stroke	boolean		false	Hides the image's profile stroke in the card	Supported: false or true.
revert	boolean		false	Inverts the display order, positioning stats to the left and the image to the right.	Supported: false or true.
photo_quality	number		15	Quality of the profile image	Repesentada pela porcentagem (1-100).
photo_resize	number		150	Resize the profile image to a specific width	In pixels. Minimum allowed value is 10px.

https://gh-readme-profile.vercel.app/api{?username,title_color,text_color,icon_color,border_color,bg_color,stroke_color,username_color,theme,title,locate,border_width,border_radius,hide,show,format,disabled_animations,hide_border,hide_stroke,revert,photo_quality,photo_resize}

Examples

Card in Portuguese

<!-- FajarKim GitHub Readme Profile -->
![GitHub Readme Profile](https://gh-readme-profile.vercel.app/api?username=FajarKim&theme=iceberg&locale=pt-BR&hide=forks,prs&show=reviews,issues_closed,discussions_started,discussions_answered)

Card in English

<!-- FajarKim GitHub Readme Profile -->
![GitHub Readme Profile](https://gh-readme-profile.vercel.app/api?username=FajarKim&theme=duskfox&hide=commits,prs,prs_merged,issues,contributed)