platane/snk

snk - GitHub贡献蛇形图生成工具

概述

snk是一个轻量级工具，专门用于将GitHub用户的贡献历史数据可视化为独特的蛇形图案。该工具能够读取GitHub用户的贡献统计信息，并将其转换为美观的SVG图像，可直接用于个人资料README、博客或网站中，展示个人的开源贡献活跃度。

核心功能与特性

• 贡献可视化：将GitHub贡献网格转换为连续的蛇形图案
• 高度自定义：支持自定义蛇身颜色、背景样式、网格大小和方向
• 多主题支持：内置多种预设主题，包括浅色、深色和彩色模式
• 灵活输出：支持SVG格式输出，可直接嵌入网页或保存为文件
• 日期范围选择：可指定特定年份或自定义时间范围生成图像
• 无API密钥需求：无需GitHub API密钥即可获取公开贡献数据

使用场景

• 个人GitHub资料README美化
• 技术博客或个人网站的贡献展示
• 开源项目贡献者活跃度可视化
• 技术社区个人成就展示
• 年度贡献总结与分享

安装与使用

Docker快速启动

bash
docker run -it --rm -v $(pwd):/app/output platane/snk --user <github-username> --output /app/output/snake.svg

Docker Compose配置

yaml
version: '3'
services:
  snk:
    image: platane/snk
    volumes:
      - ./output:/app/output
    command: --user <github-username> --output /app/output/snake.svg --theme github-dark

基本参数说明

自定义主题

通过环境变量自定义颜色：

bash
docker run -it --rm -e COLOR_SNAKE="#ff0000" -e COLOR_BACKGROUND="#000000" platane/snk --user <username>

可用环境变量：

• COLOR_SNAKE：蛇身颜色
• COLOR_BACKGROUND：背景颜色
• COLOR_GRID：网格线颜色
• COLOR_TEXT：文本颜色

高级用法

生成动画效果

bash
docker run -it --rm platane/snk --user <username> --animation --output animation.svg

组合多个用户贡献

bash
docker run -it --rm platane/snk --user user1,user2,user3 --output combined.svg

嵌入到GitHub README

1. 生成SVG文件并推送到GitHub仓库
2. 在README.md中添加：

markdown
![GitHub Contribution Snake](https://raw.githubusercontent.com/<username>/<repo>/main/snake.svg)

支持的输出格式

• SVG（默认）：矢量图形，支持无限缩放
• PNG：位图图像，需额外指定--format png参数
• GIF：动画格式，需配合--animation参数使用

注意事项

• 生成私有仓库贡献数据需要GitHub API令牌
• 过于频繁的请求可能会触发GitHub API速率限制
• 部分主题可能在不同显示设备上存在色差

示例

!https://raw.githubusercontent.com/Platane/snk/main/examples/snake.svg