README.md

GitHub Readme Profile

🙀 Generate your Stats GitHub Profile in SVG

Report Bugs · Request Feature · Ask Question

📌 Features

• 🎴 Getting Started
  • 🎨 Themes
  • ✏️ Customization
• 📑 License
• Deploy on ▲ Vercel
• 💳 Credits
• 💰 Donate
• 👥 Contributions

🎴 Getting Started

Copy-paste this into your markdown content, and that is it. Simple!

Change the ?username= value to your GitHub username.

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

🎨 Themes

With inbuilt themes, you can customize the look of the card without doing any manual customization.

Use &theme=THEME_NAME parameter like so:

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

Show Example

All inbuilt themes

GitHub Readme Profile comes with several built-in themes (e.g. transparent, dark, highcontarst).

Themes	Preview
default
transparent
dark
highcontrast

You can look at a preview for all available themes. You can also contribute new themes if you like, contributing guidelines can be found here.

✏️ Customization

You can customize the appearance of all your cards however you wish with URL parameters.

Options

Name	Description	Type	Default value
title_color	Card's title color.	string (hex color)	2f80ed
text_color	Body text color.	string (hex color)	434d58
icon_color	Icons color.	string (hex color)	4c71f2
border_color	Card's border color. Does not apply when hide_border is enabled.	string (hex color)	e4e2e2
bg_color	Card's background color.	string (hex color or a gradient in the form of angle,start,end)	fffefe
stroke_color	Profile image border color. Does not apply when hide_stroke is enabled.	string (hex color)	e4e2e2 or border_color query
username_color	Username text color.	string (hex color)	434d58 or text_color query
theme	Name of the theme, choose from all available themes.	enum	default
title	Custom title text for the card. Before use, encode the text to URL format using a tool like URL Encoder.	string	null
locale	Sets the language in the card, you can check full list of available locales here.	enum	en
border_width	Sets the border's width manually.	number	1
border_radius	Corner rounding on the card.	number	4.5
hide	Hides the specified items from stats.	string (comma-separated values)	null
show	Shows additional items on stats card.	string (comma-separated values)	null
format	Output format card option (i.e. svg, png, json, or xml).	enum	svg
disabled_animations	Disables all animations in the card.	boolean	false
hide_border	Hides the card's border.	boolean	false
hide_stroke	Hides the image's profile stroke in the card.	boolean	false
revert	Inverts the display order, positioning stats to the left and the image to the right.	boolean	false
photo_quality	Quality of the profile image, represented as a percentage (1-100).	number (percentage)	15
photo_resize	Resize the profile image to a specific width, in pixels. Minimum allowed value is 10px.	number (pixels)	150

Use the transparent theme

We have included a transparent theme that has a transparent background. This theme is optimized to look good on GitHub's dark and light default themes. You can enable this theme using the &theme=transparent parameter like so:

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

Show Example

Add transparent alpha channel to a themes bg_color

You can use the bg_color parameter to make any of the available themes transparent. This is done by setting the bg_color to a color with a transparent alpha channel (i.e. bg_color=00000000):

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

Show Example

Use GitHub's theme context tag

You can use GitHub's theme context tags to switch the theme based on the user GitHub theme automatically. This is done by appending #gh-dark-mode-only or #gh-light-mode-only to the end of an image URL. This tag will define whether the image specified in the markdown is only shown to viewers using a light or a dark GitHub theme:

[![GitHub Stats-Dark](https://gh-readme-profile.vercel.app/api?username=FajarKim&theme=dark#gh-dark-mode-only)](https://github.com/FajarKim/github-readme-profile#gh-dark-mode-only)
[![GitHub Stats-Light](https://gh-readme-profile.vercel.app/api?username=FajarKim&theme=default#gh-light-mode-only)](https://github.com/FajarKim/github-readme-profile#gh-light-mode-only)

Show Example

Use gradient color

You can use the bg_color parameter to make gradient color. This is done by setting the bg_color with format angle,start,end (comma-separated value).

![GitHub Stats](https://gh-readme-profile.vercel.app/api?username=FajarKim&bg_color=30,e96443,904e95&title_color=fff&text_color=fff&icon_color=fff)

Show Example

Hiding individual stats

You can pass a query parameter &hide= to hide any specific stats with comma-separated values.

Options: &hide=repos,stars,forks,commits,prs,prs_merged,issues, contributed

![GitHub Stats](https://gh-readme-profile.vercel.app/api?username=FajarKim&hide=repos,forks,prs_merged)

Show Example

Showing additional individual stats

You can pass a query parameter &show= to show any specific additional stats with comma-separated values

Options: &show=reviews,issues_closed,discussions_started,discussions_answered

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

Show Example

Available locales

Code	Locale
en	English
ar	Arabic (العربية)
fr	French (Français)
id	Indonesian (Bahasa Indonesia)
ja	Japanese (日本語)
ko	Korean (한국어)

See more available locale. The locale code added to file should be a 2-letter abbreviation from ISO 639-1 or a 4-letter code with a language and country code (eg. id or pt-BR). Anything appearing in the list should be fine. You can also contribute new translations if you like, contributing guidelines can be found here.

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

Show Example

📑 License

GitHub Readme Profile is released under the MIT license, which grants the following permissions:

• Commercial use
• Modification
• Distribution
• Private use

For more convoluted language, see the LICENSE.

Deploy on ▲ Vercel

Step-by-step guide on setting up your own Vercel instance.

1. Go to vercel.com.
2. Click on Log In.
3. Sign in with GitHub by pressing Continue with GitHub.
4. Sign in to GitHub and allow access to all repositories if prompted.
5. Fork this repository.
6. Go back to your Vercel dashboard.
7. To import a project, click the Add New... or + button and select the Project option.
8. Click the Continue with GitHub button, search for the required Git Repository and import it by clicking the Import button. Alternatively, you can import a Third-Party Git Repository using the Import Third-Party Git Repository link at the bottom of the page.
9. Create a personal access token (PAT) here and enable the repo and user permissions (this allows access to see private repo and user stats).
10. Add the PAT as an environment variable named GH_TOKEN.
11. In build and output settings, you set install command toggle and add command npm install typescript.
12. Click deploy, and you're good to go. See your domains to use the API!

💳 Credits

This repository contains forked from tuhinpal/readme-stats-github and inspired from anuraghazra/github-readme-stats.

💰 Donate

Love the project? Please consider donating to help it improve!

Are you considering supporting the project by donating to me? Please DO NOT!!

Please visit this link and make a small donation to help the people in need. A small donation goes a long way. ❤️

👥 Contributions

Contributions are welcome!

Specially thanks ❤️ for contributors bellow:

Want to contribute? Please note our contribution guidelines here.

Made with ❤️ and TypeScript

Copyright © 2023-present Rangga Fajar Oktariansyah