Skip to content

hehuapei/visitor-badge

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

104 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

👀 Visitor Badge

A free, lightweight visitor counter badge for your GitHub README, Issues, and Wiki pages.
One line of Markdown. No sign-up. No tracking. Just a badge.

Quick Start · Parameters · Examples · Self-host · 中文

visitor badge


Quick Start

Add this line to your README.md:

![Visitors](https://visitor-badge.laobi.icu/badge?page_id=yourname.yourrepo)

Replace yourname.yourrepo with a unique identifier for your page. Done.


Parameters

All parameters are optional except page_id.

Parameter Required Description Default
page_id Unique identifier for your page
left_text Left-side label visitors
left_color Left side color (name or hex) #595959
right_color Right side color (name or hex) #1283c3
format Compact number display (1K / 1M) disabled
logo Built-in local logo slug from the Simple Icons catalog
radius Badge corner radius (px) 3
height Badge height (px), scales proportionally 20
query_only Query without incrementing counter disabled

Note: For hex colors with #, URL-encode # as %23.
Example: #595959%23595959


Examples

Default style

![Visitors](https://visitor-badge.laobi.icu/badge?page_id=jwenjian.visitor-badge)

Visitors

Custom colors

![Visitors](https://visitor-badge.laobi.icu/badge?page_id=jwenjian.visitor-badge&left_color=red&right_color=green)

Visitors

Custom label

![Visitors](https://visitor-badge.laobi.icu/badge?page_id=jwenjian.visitor-badge&left_text=Views)

Visitors

Compact format (1K / 1M)

![Visitors](https://visitor-badge.laobi.icu/badge?page_id=jwenjian.visitor-badge&format=true)

Visitors

Built-in logo

![Visitors](https://visitor-badge.laobi.icu/badge?page_id=jwenjian.visitor-badge&logo=github)

Visitors

Example values: github, gitlab, vercel, docker, npm, discord, x, githubactions, netlify, cloudflare, telegram, wechat, youtube, react, vite, vuedotjs
Browse the full local catalog in the online builder.

Query only (don't increment)

![Visitors](https://visitor-badge.laobi.icu/badge?page_id=jwenjian.visitor-badge&query_only=true)

Visitors

Combo: all together

![Visitors](https://visitor-badge.laobi.icu/badge?page_id=jwenjian.visitor-badge&left_text=Views&left_color=%23595959&right_color=%231283c3&format=true)

Visitors


Use in HTML

<img src="https://visitor-badge.laobi.icu/badge?page_id=yourname.yourrepo" alt="visitor badge">

Self-host

Clone the repo, install dependencies, and run:

git clone https://github.com/hehuapei/visitor-badge.git
cd visitor-badge
pip install -r requirements.txt
# Set your count API endpoint in main.py
python3 main.py

Requires a compatible counting backend. The project expects a count service at a configurable endpoint. See main.py for details.


Features

  • ✅ Free & no registration
  • ✅ Custom colors (left & right)
  • ✅ Custom label text
  • ✅ Compact number format (1K / 1M)
  • ✅ Query-only mode (no count increment)
  • ✅ Daily data backup
  • ✅ Lightweight SVG response

Sponsor

💖If this project helps you, consider supporting its development:

PayPal 爱发电


Credits

Forked from jwenjian/visitor-badge with optimizations and updated infrastructure.


⭐ Star on GitHub

About

A badge generator service to count visitors of your markdown file. Fork From:jwenjian/visitor-badge

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • HTML 82.8%
  • Python 16.9%
  • Shell 0.3%