学会这几招,轻松让你的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, 也都是遵循了对应的提交规范. 下面是它的介绍网站:



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




目录
打赏
0
0
0
0
22
分享
相关文章
『GitHub项目圈选15』推荐5款本周 深受程序员喜爱 的开源项目
『GitHub项目圈选15』推荐5款本周 深受程序员喜爱 的开源项目
210 1
【创意坊】探秘 GitHub 惊艳开源项目!
【创意坊】探秘 GitHub 惊艳开源项目!
120 0
接住我的下巴,Github上超火的异步编程神仙笔记也太香了
异步编程是可以让程序并行运行的一种手段,可以让程序中的一个工作单元与主应用程序线程分开独立运行,进而提高应用程序的性能和响应能力等。 虽然Java为不同技术域提供了相应的异步编程技术,但是这些异步编程技术被散落到不同技术域的技术文档中,没有一个统一的文档对其进行梳理归纳。另外这些技术之间是什么关系,各自的出现都是为了解决什么问题,我们也很难找到相关资料来解释。 下面要介绍这份大牛总结的笔记的出现则是为了打破这种局面,旨在对Java中相关的异步编程技术进行归纳总结,为大家提供一个统一文档来查阅、参考
Github霸榜半年的阿里并发编程速成笔记究竟有什么魅力?
大家都知道金三银四是程序员跳槽的黄金时期,很多程序员都想着能抓住这一机会,挺进大厂!我曾经整理过一份详细的大厂岗位需求表,很多20K以上的Java岗位,基本都要求具备高并发分布式的相关经验。老练的面试官知道,对于一个 Java 程序员而言,如果对并发编程有全面而深入的了解,那说明技术功底足够扎实。所以,并发编程也是大厂面试的必考项。并发编程,也直接成为了资深开发和小白开发本质的分水岭。
真香!Github一夜爆火,阿里性能优化不传之秘终于开源
性能调优,是从开发岗跃迁至架构岗的拦路虎。如果你是一个小白,那么恭喜你性能优化这个东西你暂时还不需要扛着。但如果你是公司的中坚力量,想把技术水平往架构层面靠近,那么性能优化这个东西你必须要扛下来,并且解决它。
最近这个 GitHub 项目,增长有点猛
今天给大家分享一个 GitHub 刷题项目,也是目前我们 Doocs 成员们在积极维护的一个项目。
135 0
最近这个 GitHub 项目,增长有点猛
开发者必备!Github上1.6W星的「黑魔法」,早知道就不会秃头了
当程序员谈论开发设计时,常常会聊到非常多的定律,而Github上的一个名为「hacker-laws」的仓库收录了一些最常见的定律、原则等,获得了16.3k的Star。
246 0
开发者必备!Github上1.6W星的「黑魔法」,早知道就不会秃头了
AI助理

你好,我是AI助理

可以解答问题、推荐解决方案等