Count visitors for your README.md, Issues, PRs in GitHub

in just one line markdown code


💗 Donate 💗Getting started


Docs

How to use?

All you have to do is to add below markdown markup to your markdown content:

                
                    ![visitors](https://visitor-badge.lithub.cc/badge?page_id=page.id&left_color=red&right_color=green)
                
            

In which,

The url parameter page_id is REQUIRED, please use the unique string to best represent your page.

I recommend you to follow page_id rules below:

  1. For README.md file, use ${your.username}.${your.repo.id}, https://visitor-badge.lithub.cc/badge?page_id=lizheming.visitor-badge for example.
  2. For Issue body, use ${your.username}.${your.repo.id}.issue.${issue.id}, https://visitor-badge.lithub.cc/badge?page_id=lizheming.visitor-badge.issue.1 for example.

or any other markdown content, please give an unique string to distinguish

The url parameter left_color and right_color is optional, you can customize the badge color by passing the two parameters.

The values supports color names(like green) and RGB in hex string starts with a hashtag(like #66ccff)


FAQ

Can I use this in HTML file?

Sure!

All you have to do is to insert a <img> to your HTML:

                    
                        <img src="https://visitor-badge.lithub.cc/badge?page_id=page.id" alt="visitor badge"/>
                    
                

For page_id parameter, follow the rules.

Is this free?

Yes and it will always be free and no limitations!

If you found this useful, you can buy me a coffee ☕️ or give a star ✨


What's next?

What new features will be available in the next release?