GitHub displays some basic metrics on your main account page, including your contributions laid out by year, and a graph of what type of contributions you've made.
This is an excellent overview, however, there's so much more you can do with your GitHub activity. That's where the following tools come in.
There are many options for displaying GitHub metrics using Markdown. This page discusses two popular options for displaying GitHub metrics.
GitHub user anuraghazra put together the quick and easy to use GitHub Readme Stats. User lowlighter built the extensive Metrics. The first is simpler and gives you a grade rank for your contributions. The second is far more involved, allows you to configure the widget to include a wide variety of information, and provides an easy setup option.
The GitHub Readme Stats tool allows you to add dynamically generated GitHub stats to your profile. The documentation is thorough and covers how to apply all the available configurations to your stats card.
It begins with providing the basic Markdown you need to include the default themed stats card in your profile. You'll need to update the code with your username for it to display your stats.
The following is an example of the Markdown needed to include the default themed card with no icons.
This is how the above Markdown would render in your profile.
Likely the most popular configuration option would be to include the icons and add a theme. The Markdown to apply a theme (which includes showing the icons) is available on the main documentation page, and on its own Available Themes page.
Here is the Markdown to apply the tokyonight theme.
The Markdown above would render as follows in your profile.
The Available Themes page lists all of the available builtin themes for GitHub Readme Stats, including example cards so you know exactly what the theme looks like. For more information, including what the rankings mean and configuring more of it yourself, read through the main documentation.
The Metrics tool generates dynamic metrics that can be embedded in your GitHub profile README. There are a staggering number of plugins and options to include in this widget. It's important to note that feature availability is based on how you choose to set up Metrics.
There are five ways to set up Metrics. Four of them provide access to all of the features. However, they are more advanced and require knowledge in various areas that many folks do not have. You're welcome to check them out, and if they're in your wheelhouse, consider trying them out. The simplest way, which is what will be covered in this section, is to visit a website that allows you to configure the widget with a dynamic preview. This method does not require any local or remote set up, but it only allows access to a limited feature set.
To begin, visit the Metrics configuration site. The widget defaults to a set of base content. The preview initially shows placeholder information.
To update to your information, you'll enter your GitHub username in the box on the top of the left sidebar, and click Generate your metrics!. You can test this out with the default info by adding your username and clicking the button.
Now, you can begin adding more sections to your widget. In the left sidebar, you'll find the Additional Plugins section that contains subsections, each with a list of plugins preceded by checkboxes.
Each time you check a box for a new plugin, the preview will revert to placeholder information, including placeholder info for the newly selected plugin. At any time, you can click the Generate your metrics! button to see your chosen plugins rendered with your GitHub info. Simply be aware, if you change the included plugins by adding or removing, it will once again revert to placeholder info.
If you try to include an unavailable plugin, a warning will appear under the Generate your metrics! button letting you know which unavailable plugins you attempted to add. If you check more than one unavailable plugin, they will all be listed in the same warning. You will not be able to click the Generate button as long as an unavailable plugin is checked.
Read through the list, and see what interests you. If you're uncertain what a particular plugin displays, check the box to view it in the preview. You can always remove it if it's not something you're interested. There are so many available, you should definitely be able to generate a collection of information that fits and represents you.
As you're going through, you can generate your metrics at any time. You should always click Generate your metrics! before copying the provided Markdown from the Markdown code tab. This ensures your user information is populated into the Markdown configuration code.
The following is the Markdown code for including the base content, most used languages, achievements, and notable contributions.
The above Markdown would render into your profile as follows.
For full information on all plugins and options available, setup options available, and a list of plugins with links to details and configuration about each plugin, check out the Metrics documentation.
Text editor powered by tinymce.
