学会这几招,轻松让你的github脱颖而出

简介: 今天分享的内容我想每一位对开源感兴趣的朋友都或多或少的知道, 也是我在做开源项目中用到的一些强大的工具, 可以让我们的开源项目和 github 主页更加富有展现力, 最后会分享一个我自己的 github 主页的 readme.md, 大家可以参考学习一下.在读完本文之后大家可以收获:

网络异常,图片无法展示
|


今天分享的内容我想每一位对开源感兴趣的朋友都或多或少的知道, 也是我在做开源项目中用到的一些强大的工具, 可以让我们的开源项目和 github 主页更加富有展现力, 最后会分享一个我自己的 github 主页的 readme.md, 大家可以参考学习一下.

在读完本文之后大家可以收获:


  • 使用 readme-md-generator 快速美化你的 README.md
  • 使用 gitHub-readme-stats 自动生成个人统计分析报表
  • 使用 git-emoji 让你的代码提交记录可视化


一. 如何让你的开源项目有个漂亮的README.md ?


逛了一圈社区之后小夕发现了 readme-md-generator.


readme-md-generator 通过扫描我们的 package.jsongit 配置来帮助我们生成对应的 readme 结构。


网络异常,图片无法展示
|


产生的 README.md 类似如下展现:


网络异常,图片无法展示
|


另外, 一个优秀的 package.json 应该包含如下几个元数据:


{
  "name": "H5-Dooring",
  "version": "1.1.3",
  "description": "H5-Dooring是一款功能强大,开源免费的H5可视化页面配置解决方案,致力于提供一套简单方便、专业可靠、无限可能的H5落地页最佳实践。技术栈以react为主, 后台采用nodejs开发。",
  "author": "作者信息",
  "license": "开源协议",
  "homepage": "主页地址",
  "repository": {
    "type": "git",
    "url": "git仓库地址"
  },
  "bugs": {
    "url": "供他人提issue的地址"
  },
  "engines": {
    "npm": ">=5.5.0",
    "node": ">=9.3.0"
  }
}

大家在做开源项目的时候也可以参考如上规范, 让自己的开源项目更健壮美观, 接下来分享一个我用这个工具生成的 readme.md 效果:


网络异常,图片无法展示
|


地址: mitu-editor | 轻量且强大的图片编辑器


二. 使用 github-readme-stats 自动生成个人统计分析报表


我们都知道 github 的个人主页默认的配置很单调, 但是我们看很多大佬的 github 主页, 展现非常漂亮, 比如这位大大:


网络异常,图片无法展示
|


这是为什么呢? 实不相瞒, 上图大佬就是发明美化 github个人主页 工具的作者, 我们可以看到他的个人主页有非常漂亮的统计图, 而生成这种动态统计图的工具就是 github-readme-stats. 它可以在我们的 README 中获取动态生成的 GitHub 统计信息, 而我们的使用方法也很简单, 只需要在自己 github 主页的 README 中加入如下代码:


[![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra)](https://github.com/anuraghazra/github-readme-stats)


我们只需要更改 ?username= 的值为我们自己的 GitHub 用户名即可.


定制自己的统计数据主题


同时, 我们还可以轻松定制统计卡片的主题, 该工具默认提供的主题如下:


网络异常,图片无法展示
|


同样, 我们只需要在 README 中加入如下代码:


![Anurag's GitHub stats](https://github-readme-stats.vercel.app/api?username=anuraghazra&show_icons=true&theme=radical)


这样就能轻松选择自己喜欢的主题, 更强大的是我们还可以自定义主题颜色, 大家可以在 github 上亲自体验一下.


添加自己项目的热门语言卡片


热门语言卡片显示了我们在 GitHub 上的开源项目常用的编程语言, 展示如下:


网络异常,图片无法展示
|


当然也可以设置成紧凑型布局:


网络异常,图片无法展示
|


要实现这样的效果也很简单, 只需要配置如下代码:


[![Top Langs](https://github-readme-stats.vercel.app/api/top-langs/?username=anuraghazra&layout=compact)](https://github.com/anuraghazra/github-readme-stats)


更多的配置大家可以在 github 慢慢挖掘, 该项目的 github 地址如下:


github-readme-stats


这里也展示一下我通过配置之后的 github 个人主页的界面效果:



网络异常,图片无法展示
|


三. 使用 git-emoji 让你的代码提交可视化


git-emojigit 提交信息的 emoji 指南, 我们按照它的规范提交 log 日志, 将会生成形象易懂的提交表情, 如下:



网络异常,图片无法展示
|



我们看到的比较有名的开源项目提交都会有形象的 emoji, 也都是遵循了对应的提交规范. 下面是它的介绍网站:



网络异常,图片无法展示
|




目录
相关文章
|
运维 Ubuntu Linux
【树莓派4B安装18.04桌面+远程SSH】
【树莓派4B安装18.04桌面+远程SSH】
732 0
|
存储 API Docker
只需10分钟!就能用Flask,Docker和Jenkins部署机器学习模型
一杯茶的功夫部署完成机器学习模型!
3603 1
|
Java
解决Java- 错误: 找不到或无法加载主类 HelloWorld.java
针对初学者使用javac,java等命令编译class文件时出现的经典问题,提供解决思路和方法。
9887 0
解决Java- 错误: 找不到或无法加载主类 HelloWorld.java
|
10月前
|
Kubernetes Cloud Native 调度
云原生批量任务编排引擎Argo Workflows发布3.6,一文解析关键新特性
Argo Workflows是CNCF毕业项目,最受欢迎的云原生工作流引擎,专为Kubernetes上编排批量任务而设计,本文主要对最新发布的Argo Workflows 3.6版本的关键新特性做一个深入的解析。
|
5月前
|
Java Spring 容器
两种Spring Boot 项目启动自动执行方法的实现方式
在Spring Boot项目启动后执行特定代码的实际应用场景中,可通过实现`ApplicationRunner`或`CommandLineRunner`接口完成初始化操作,如系统常量或配置加载。两者均支持通过`@Order`注解控制执行顺序,值越小优先级越高。区别在于参数接收方式:`CommandLineRunner`使用字符串数组,而`ApplicationRunner`采用`ApplicationArguments`对象。注意,`@Order`仅影响Bean执行顺序,不影响加载顺序。
367 2
|
10月前
|
消息中间件 存储 缓存
QPS多少,才算高并发 ?
本文详解高并发概念及 QPS 标准,大厂面试高频点,建议掌握收藏。关注【mikechen的互联网架构】,10年+BAT架构经验分享。
QPS多少,才算高并发 ?
VSCode将某个字符替换为换行符并换行显示
VSCode将某个字符替换为换行符并换行显示
1106 1
VSCode将某个字符替换为换行符并换行显示
|
11月前
|
自动驾驶 物联网 5G
|
11月前
|
域名解析 网络协议 安全
DNS查询工具简介
DNS查询工具简介
1150 4
|
存储 缓存 程序员
CPU组成结构
CPU组成结构
719 0