导读

README.md作为Markdown文件，GitHub支持了Markdown的基本语法，但不支持CSDN提供的强大的公式编辑$$功能以及标题功能等。

看到别人的GitHub同名项目里README.md丰富多彩，你是否羡慕呢？本文给读者分享几种常见的装饰README.md的小技巧，遇到新鲜的玩法会持续更新。

徽章图片

Shields IO有丰富的图片资源可以用在GitHub用户的README.md中，Shields项目也已开源。

该项目以SVG和raster格式提供简洁、一致和易读的徽章的服务，可以轻松地包含在GitHub的README.md文件或任何其他网页中。该服务支持数十种持续集成服务、包注册表、分发、应用商店、社交网络、代码覆盖服务和代码分析服务。每个月它提供超过7.7亿张图片，并被一些世界上最受欢迎的开源项目使用，如 VS Code、Vue.js 和 Bootstrap 等等。

比如：

Emoji

有很多可以提供Emoji图片的网站，试推荐一个：emojipedia。

数据统计

github-readme-stats是一款非常有趣的GitHub数据统计可视化工具，也提供了中文文档，可以在GitHub用户的README.md里呈现出如下效果：

数据统计卡片有很多样式，还支持渐变色：

支持自定义repo卡片：

支持热门语言统计：

贪吃蛇

逛GitHub的时候发现了一个有趣的README.md内容，就是snack，容笔者称其为“贪吃蛇”。

比如下图为某GitHub用户的contributions统计：

通过一系列的操作，呈现在README.md上的是一个SVG格式的贪吃蛇动图：

操作方法如下：

将以下yml内容填入以后点击“Start Commit”，注意填写用户名：

name: Generate Datason:schedule:- cron: "* */12 * * *"workflow_dispatch:jobs:build:name: Jobs to update datasruns-on: ubuntu-lateststeps:# Snake Animation- uses: Platane/snk@masterid: snake-gifwith:github_user_name: 你的用户名svg_out_path: dist/github-contribution-grid-snake.svg- uses: crazy-max/ghaction-github-pages@v2.1.3with:target_branch: outputbuild_dir: distenv:GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

通过以上方法生成了SVG文件，README.md引入方法就是：
![Snake animation](https://github.com/你的用户名/你的用户名/blob/output/github-contribution-grid-snake.svg)

两个“你的用户名”都是为了凑URL，第一个是你的用户名必须要有，第二个是你的repo一般是同名repo，所以需要填这个。

【Git】GitHub同名项目实现丰富多彩的README.md相关推荐

springboot 建readme_经验分享：给项目创建和编写README.md文件的步骤
在项目开发过程中,不仅要注意代码的编写质量,也要为合作开发打好基础,尤其是合作开发的时候,同事直接的代码需要熟悉,这就需要在开发的时候进行注释操作,方便别人维护和熟悉代码.除了上述两个重要的点之外,还 ...
ideagit更新一个文件_IDEA 配置 Git,GitHub, 获取项目, 更新项目 (Windows 版本)
在本地配置 Git 首先呢在本地配置好 Git 客户端,我用的是 windows 系统,直接下载安装板下载就 OK, 然后配置 Git,告诉 Git 需要连接的名字与邮箱,名字随意,邮箱要与 GitH ...
个人项目github链接及README.md
链接: https://github.com/Silvia9/Word-Count README: https://github.com/Silvia9/Word-Count/blob/mas ...
git github 快速入门
本节内容 github介绍安装仓库创建& 提交代码代码回滚工作区和暂存区撤销修改删除操作远程仓库分支管理多人协作 github使用忽略特殊文件.gitignore 为什么要 ...
git/github的使用
内容最后更新时间:2018-08-10 以下内容是我在收集而来,再经过自己的经验修改而成,希望对你有用(在不断的更新中) 欢迎来到Github 初识Github 版本控制的介绍熟练使用Git/Git ...
git学习创建项目仓库
登录git 这是git首页,已有帐号,点右上角sign in 进入登录页输入帐号密码登录之后的页面 Browse activity -- 浏览活动就项目的一些更新信息 Discover repo ...
【Git】PyCharm项目关联Git的解决方案
核心操作和<IntelliJ_IDEA项目关联Git的解决方案>是一致的,毕竟都是JetBrains家的产品. 这次简明扼要地总结一下步骤(默认你已经能做到本地Git和Github关联): ...
git github 快速入门
本节内容 github介绍安装仓库创建& 提交代码代码回滚工作区和暂存区撤销修改删除操作远程仓库分支管理多人协作 github使用忽略特殊文件.gitignore 为什么要 ...
git/github的使用(入门到中阶)
内容最后更新时间:2017-08-10 以下内容是我在收集而来,再经过自己的经验修改而成,希望对你有用(在不断的更新中) 博客地址欢迎来到Github 初识Github 版本控制的介绍熟练使用Gi ...

【Git】GitHub同名项目实现丰富多彩的README.md

文章目录

导读

徽章图片

Emoji

数据统计

贪吃蛇

【Git】GitHub同名项目实现丰富多彩的README.md相关推荐

最新文章

热门文章