Basic Usage

Basic Usage

To display a GitHub stats card in your profile README, use the following Markdown syntax:

[![GitHub Stats](https://gh-readme-profile.vercel.app/api?username=USERNAME)](https://github.com/FajarKim/github-readme-profile)

Replace USERNAME with your GitHub username.

Required Parameter

The only required parameter is username. Example:

![GitHub Stats](https://gh-readme-profile.vercel.app/api?username=FajarKim)

Example with Theme

Add a theme directly:

![GitHub Stats](https://gh-readme-profile.vercel.app/api?username=FajarKim&theme=dark)

Example with Multiple Customizations

![GitHub Stats](https://gh-readme-profile.vercel.app/api?username=FajarKim&theme=highcontrast&hide_border=true&show=reviews,issues_closed)

Output Format

By default, the card is displayed as SVG. You can change the output format using the format parameter:

Format	Description
svg	(Default) Scalable vector graphic
png	Raster image with white background
json	Statistics data in JSON format
xml	Statistics data in XML format

Example:

![GitHub Stats](https://gh-readme-profile.vercel.app/api?username=FajarKim&format=png)

Hiding Border and Stroke

• hide_border=true – Removes the outer card border
• hide_stroke=true – Removes the stroke around the profile picture

![GitHub Stats](https://gh-readme-profile.vercel.app/api?username=FajarKim&hide_border=true&hide_stroke=true)

Reversing Layout

Use revert=true to move the stats column to the left and the profile picture to the right:

![GitHub Stats](https://gh-readme-profile.vercel.app/api?username=FajarKim&revert=true)