Skip to content

max1mde/fancy-readme-stats

Repository files navigation

Example card

What is different in this fork?

  • Animated parallax backgrounds for every card
  • Additional query parameters like dark_bg or footer for the stats card
  • A full-width version of the stats card

Leave a star ⭐ if you want me to make more themes

Getting Started

To use this card in your GitHub profile README, add the following Markdown snippet to your README file:

[![Fancy Profile Card](https://fancy-readme-stats.vercel.app/api?username=YOUR_GITHUB_USERNAME&theme=beach&[email protected]&show_icons=true&title=Your%20name&description=Your%20description&include_all_commits=true&show_icons=true)](https://github.com/max1mde/fancy-readme-stats)

Special characters

Character URL Encoded
Space %20
# %23
$ %24
% %25
& %26
' %27
+ %2B
< %3C
= %3D
_ %5F
New line %0A
) %29

Global Parameters

Parameter Type Description
dark_bg number Sets the background darkness level (e.g., 0 for light, 10 for pitch black).
border_radius number Adjust the border's corner roundness! Use 5 for slight rounding and 15 for a more rounded effect.
hide_border boolean Determines whether to hide the border (true to hide, false to show).
theme boolean Choose from one of the themes below

Themes

  • forest
  • forest_winter
  • forest_autumn
  • beach
  • city
  • rain
  • red_rain
  • snow

Here is a list of all themes also the not animated ones.

Preview:

Beach City Forest Forest Winter Forest Autumn Rain Red Rain Snow

Stats card Parameters

Parameter Type Description
height number Sets the height of the card (230 is the default and 170 the min value).
footer string Sets the bottom text (Same as the legacy email parameter)
hide string[] Hides specified items. Available values: stars, commits, prs, issues, contribs, prs_merged
show_icons boolean Shows icons next to stats
hide_title boolean Hides the title/name
include_all_commits boolean Count total commits instead of just current year
line_height number|string Sets the line height between text
title string Sets a custom title
disable_animations boolean Disables all animations in the card
number_format string Choose between short (1.2k) or long (1234) number formatting
text_bold boolean Makes text bold (true by default)
description string Adds a description text below the title
exclude_repo string Exclude repositories (comma-separated) - Example: repo1,repo2,repo3

Cards

There are also other cards than the stats card above.

Repository

Gists



Community & Support

Discord Banner

Contributing

Contributions are welcome!