Note: This is a fork implementation of github-readme-stats and I simply allow it to work with the typeracer API.

Typeracer Readme stats

Get dynamically generated Typeracer stats on your READMEs!

View Demo · Report Bug · Request Feature · Ask Question

Features

• Typeracer Stats Card
• Themes
• Customization
  • Common Options
  • Stats Card Exclusive Options

Typeracer Stats Card

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

Change the ?username= value to your Typeracer username.

[![Steven's Typeracer stats](https://typeracer-readme-stats.vercel.app/api?username=juninight29)](https://github.com/steven-steven/typeracer-readme-stats)

Hiding individual stats

To hide any specific stats, you can pass a query parameter &hide= with comma-separated values.

Options: &hide=cg,gamesWon,bestGameWpm,wpm,recentAvgWpm,recentScores

![Steven's Typeracer stats](https://typeracer-readme-stats.vercel.app/api?username=juninight29&hide=cg,gamesWon)

Showing icons

To enable icons, you can pass show_icons=true in the query param, like so:

![Steven's Typeracer stats](https://typeracer-readme-stats.vercel.app/api?username=juninight29&show_icons=true)

Themes

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

Use &theme=THEME_NAME parameter like so :-

![Steven's Typeracer stats](https://typeracer-readme-stats.vercel.app/api?username=juninight29&theme=onedark)

All inbuilt themes:-

dark, radical, merko, gruvbox, tokyonight, onedark, cobalt, synthwave, highcontrast, dracula

You can look at a preview for all available themes in the forked repo or checkout the theme config file.

Customization

You can customize the appearance of your Stats Card with URL params.

Common Options:

• title_color - Card's title color (hex color)
• text_color - Body text color (hex color)
• icon_color - Icons color if available (hex color)
• border_color - Card's border color (hex color). (Does not apply when hide_border is enabled)
• bg_color - Card's background color (hex color) or a gradient in the form of angle,start,end
• hide_border - Hides the card's border (boolean)
• theme - name of the theme, choose from all available themes
• border_radius - Corner rounding on the card_

Gradient in bg_color

You can provide multiple comma-separated values in the bg_color option to render a gradient, with the following format:

&bg_color=DEG,COLOR1,COLOR2,COLOR3...COLOR10

Stats Card Exclusive Options:

• hide - Hides the specified items from stats (Comma-separated values)
• hide_title - (boolean)
• hide_rank - (boolean) hides the rank and automatically resizes the card width
• show_icons - (boolean)
• count_private - Count private commits (boolean)
• line_height - Sets the line-height between text (number)
• custom_title - Sets a custom title for the card
• disable_animations - Disables all animations in the card (boolean)

---

All Demos

• Default

• Hiding specific stats

• Showing icons

• Customize Border Color

• Themes

Choose from any of the default themes

• Gradient

• Customizing stats card (not working)

---

Contributions are welcome! <3

Made with ❤️ and JavaScript.