docs: add visitor map configuration to README and update docs.md

- Added visitor map section to README.md after GitHub Contributions Graph
- Updated visitor map description in content/pages/docs.md with privacy details
- Documents configuration options in src/config/siteConfig.ts
- Explains Netlify geo detection and theme-aware colors
This commit is contained in:
Wayne Sutton
2025-12-21 15:58:43 -08:00
parent 1e67e492c8
commit 4a912fd345
32 changed files with 1129 additions and 37 deletions

View File

@@ -366,6 +366,26 @@ The graph displays with theme-aware colors that match each site theme:
Uses the public `github-contributions-api.jogruber.de` API (no GitHub token required).
## Visitor Map
Display real-time visitor locations on a world map on the stats page. Uses Netlify's built-in geo detection (no third-party API needed). Privacy friendly: only stores city, country, and coordinates. No IP addresses stored.
Configure in `src/config/siteConfig.ts`:
```typescript
visitorMap: {
enabled: true, // Set to false to hide the visitor map
title: "Live Visitors", // Optional title above the map
},
```
| Option | Description |
| --------- | ------------------------------------------- |
| `enabled` | `true` to show, `false` to hide |
| `title` | Text above map (set to `undefined` to hide) |
The map displays with theme-aware colors. Visitor dots pulse to indicate live sessions. Location data comes from Netlify's automatic geo headers at the edge.
### Favicon
Replace `public/favicon.svg` with your own icon. The default is a rounded square with the letter "m". Edit the SVG to change the letter or style.