关于 READEME.md 自动生成和手动编辑两种方法介绍
先看下要做什么吧
- 打开https://github.com/cxvh会看到
cxvh
仓库的README.md
文件 - 接下来从两方面介绍如何去编辑
- 首选快速生成的方法,简单,快捷
- 自定义编辑、构建
一、快速生成
- 打开生成网站
Title
是标题,有示例,参考编写即可Subtitle
小标题,可以做个简短的自我描述Work
项目名称+链接、在学习什么、关于、邮箱、所有的项目链接、你的博客地址、简历地址、你认为你很有趣~Skills
技能专长、选中你会的,会生成图标Social
社交、联系方式Add-ons
附加组件、会生成一些分析图标等Support
支持(没用过不太懂)
- 配置好后点击
Generate README
生成,复制到你的https://github.com/名称/仓库名和名称一样的仓库/README.md
,然后commit
就看到了
优点: 操作简单,适合新手,界面友好。
缺点: 个性化程度有限,部分内容需手动调整。
二、自定义编辑、构建
这里主要说下流程和需要注意的细节(以下通过开发工具为vscode
,使用github
仓库)
1. 集成 WakaTime 统计
- 先从
wakatime
说起,它主要对项目进行分析,它通过你本地的开发工具打开的项目、链接对应git
仓库进行分析- 打开网站https://wakatime.com/,并注册登录。
- 安装开发工具插件https://wakatime.com/plugins,
vscode
打开项目后搜索插件安装,安装完成后弹出输入框WakaTime API Key
,粘贴Secret API Key
然后去刷新网站就能看到了(其他项目用vscode
打开后ctrl+shift+p
键入WakaTime API Key
回车粘贴Secret API Key
)- 打开https://wakatime.com/settings/account就能看到:
Secret API Key
- 打开https://wakatime.com/settings/account就能看到:
- 网站获取
github
仓库,打开https://wakatime.com/integrations,去关联授权 - 本地项目关联
github仓库
- 打开https://wakatime.com/share,点击第一个图表—>网站拉取到的
github仓库
,点击开关按钮—>弹出复选框去关联本地项目,点击Connect this repo.
—>出来的是本地项目列表,点击对应的项目—>点击Connect to GitHub
—>出来仓库下拉框,选中点Save
即可完成关联!
- 打开https://wakatime.com/share,点击第一个图表—>网站拉取到的
- 使用编码花费时间图标
Repo Badges
,打开https://wakatime.com/share/badges,点击项目绿色开关按钮右边的图标,复制代码去粘贴 - 使用实时图表,显示语言,编辑器或总编码活动
Embeddable Charts
,打开https://wakatime.com/share/embed,配置好后点Get Embeddable Code
生成出弹出引用代码(新项目过了晚上12点以后可能才会有数据)
1 | ### :gem: 投入网站时间: |
2. 使用 GitHub Actions 自动生成统计
- 使用
github
的actions
生成,扩展地址https://github.com/marketplace/actions/profile-readme-development-stats- 配置
github
仓库环境变量,token
和Secret API Key
- 项目中配置
yml
,.github/workflows/waka-coding-stats-workflows.yml
,并commit
、push
- 打开https://github.com/cxvh/cxvh/actions,点
Run workflow
即可构建,会替换掉README.md
中的这个注释:<!--START_SECTION:waka--><!--END_SECTION:waka-->
(两个注释中间敲个回车吧,和文档保持一致没错)
- 配置
1 | # waka-coding-stats-workflows.yml |
1 | # 这是生成的 |
注意事项:
README.md
中需要有<!--START_SECTION:waka--><!--END_SECTION:waka-->
注释,自动生成内容会插入到这两者之间。- 若自动更新失败,请检查
token
权限、API Key是否正确,Actions日志可帮助排查问题。
三、常用分析工具和图标生成网站
- https://metrics.lecoq.io/:综合性 GitHub 统计卡片
- https://github.com/anuraghazra/github-readme-stats:个人统计卡片
- https://github.com/ryo-ma/github-profile-trophy:奖杯风格统计
- https://shields.io/:自定义徽章生成,非常实用
四、常见问题解答(FAQ)
Q1:自动生成内容没有显示?
A:请确认README.md
中有正确的注释标记,Actions配置无误,Secrets变量填写正确。
Q2:WakaTime 没有统计到数据?
A:请确保本地编辑器插件已安装并配置 API Key,且项目已正确关联。
Q3:如何自定义统计内容样式?
A:大部分生成工具支持参数定制,具体可参考各自文档。
五、视频教程推荐
开头中间结尾有广告,建议跳过广告部分观看核心内容:
本文持续更新,欢迎补充交流!如有疑问可留言或私信。
本博客所有文章除特别声明外,均采用 CC BY-NC-SA 4.0 许可协议。转载请注明来自 BARAN的小站🔥🔥🔥!