geo-scorev1.8.3
  1. 首页
  2. 文档
  3. 徽章

给 README 加一枚 geo-score 徽章

geo-score 可以把分数和档位写成一枚 README 徽章:提交进仓库的 SVG,或者不用每次换图也能保持更新的 shields.io endpoint JSON。徽章是可选的,也不改变任何东西:它从不影响分数,也从不决定一个站能否进入公开榜单、排在哪里。

怎么生成 SVG 徽章?

geo-score example.com --badge docs/aiv-badge.svg

徽章的样子和你已有的构建徽章一致,带分数、档位和无障碍标签;颜色随档位变化,被门槛封顶的分数会注明 (gate capped)。把它提交到 README 旁边,并链接到分数的含义:

[![AIV readiness, scored with geo-score](docs/aiv-badge.svg)](https://github.com/jianruntech/geo-score)

提交进仓库的 SVG 只反映写它的那一次运行。

怎么让徽章保持更新?

把同一枚徽章写成 shields.io endpoint JSON,放到任何能用网址访问的地方(仓库里的原始文件、gist、发布附件、你自己的网站),再让 shields.io 指向这个网址:

geo-score example.com --badge-json aiv-badge.json
{"schemaVersion": 1, "label": "AIV readiness", "message": "71/100 Solid", "color": "#2f8f52", "cacheSeconds": 86400}
![AIV readiness](https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2FOWNER%2FREPO%2Fmain%2Faiv-badge.json)

shields.io 会把这份 JSON 缓存一天(cacheSeconds)。徽章只和最近一次写文件的运行一样新,所以请定时重跑,或在每次部署后重跑。

GitHub Action 能写徽章吗?

能。把 badge 输入设成一个路径:以 .json 结尾的写 endpoint JSON,其余写 SVG,badge-path 输出会告诉你写到了哪里。提交或发布这个文件,是你自己工作流里的一步。见 GitHub Action。

挂徽章对上榜有帮助吗?

没有。徽章或回链从不影响分数,也从不决定一个站能否进入公开榜单、排在哪里。网站上榜只走贡献指南里的「Add a site」流程,从不拿链接交换。