开源项目的 README.md 这样写,hr 看了都心动

简介: 开源项目的 README.md 这样写,hr 看了都心动

大家好,我是南城余。

最近在搞项目的开源 README.md 时,看到有的大佬的 README.md 前面都会有 badge 标识和多彩的 tag 标签。都看着超级高级,就想着也来实践下。

今天一篇文章带着大家个性化你的 README.md。如下图片:


这里我先放下适用于所有 Spring Boot 项目和 React 项目的通用模板。方便大家直接 COPY。

因为搞这东西,还挺费时的,这里直接给大家放下通用的模板。

下方也有自定义你的专属 README.md 步骤哦~

通用模板

Spring Boot 项目

只需要修改下方 nanchengcyu/TechMindWave-backend 为你自己的名字和仓库即可

另外:如果项目的 Java 版本和 SpringBoot 版本与下方不一致,也可以修改下方对应数字即可

<h1 align="center">自动图文生成系统</h1>
<p align="center">
  <img src="https://img.shields.io/github/languages/code-size/nanchengcyu/TechMindWave-backend" alt="code size"/>
  <img src="https://img.shields.io/badge/Spring%20Boot-2.5.4-brightgreen" alt="Spring Boot"/>
  <img src="https://img.shields.io/github/languages/count/nanchengcyu/TechMindWave-backend" alt="languages"/>
  <img src="https://img.shields.io/badge/Java-8-blue" alt="Java"/>
  <img src="https://img.shields.io/github/last-commit/nanchengcyu/TechMindWave-backend" alt="last commit"/><br>
  <img src="https://img.shields.io/badge/Author-nanchengyu-orange" alt="Author" />
</p>
<hr>

效果图展示

React 项目
<h1 align="center">自动图文生成系统</h1>
 
<p align="center">
  <img src="https://img.shields.io/github/languages/code-size/nanchengcyu/TechMindWave-frontend" alt="code size"/>
  <img src="https://img.shields.io/badge/React-17.0.2-blue" alt="React"/>
  <img src="https://img.shields.io/badge/Ant%20Design%20Pro-5.0.0-brightgreen" alt="Ant Design Pro"/>
  <img src="https://img.shields.io/github/languages/count/nanchengcyu/TechMindWave-frontend" alt="languages"/>
  <img src="https://img.shields.io/github/last-commit/nanchengcyu/TechMindWave-frontend" alt="last commit"/>
  <br>
  <img src="https://img.shields.io/badge/Author-nanchengyu-orange" alt="Author" />
</p>
<hr>

效果图展示

自定义你的 README.md

步骤如下:

1)你可以用下面这个网站,自定义你的标签

https://shields.io/

2)点击 Get Started,进入下面这个页面自定义你的 badge 标识和多彩的 tag 标签

如下方红色箭头所示,推荐使用 HTML 粘贴到 README.md 中。

此步骤参考于

https://www.cnblogs.com/knuzy/p/15320038.html

但是步骤有点过时,推荐使用上方我的通用模板!


目录
相关文章
|
9月前
个人GitHub的md规范
个人GitHub的md规范
55 0
|
27天前
|
Kubernetes JavaScript 前端开发
OpenSource项目Github Trending一周回顾
OpenSource项目Github Trending一周回顾
|
2月前
|
数据可视化 算法 API
【README.md 指南 】如何编写 README.md:打造出色的开源项目文档
【README.md 指南 】如何编写 README.md:打造出色的开源项目文档
1006 0
|
2月前
|
程序员 数据库
十一假期,分享几个好玩儿的GitHub项目
十一假期,分享几个好玩儿的GitHub项目
40 0
|
12月前
|
JavaScript Go Cloud Native
你要是还学不会,请提刀来见 Typora+PicGo+Gitee + node.js 打造个人高效稳定优雅图床 |Go主题月
经过前面两弹的介绍,相信大家对图床都不陌生了吧,但是小魔童觉得这样做法还是不方便,使用 github的仓库来存放图片,如果不能上外网的话是不能展示图片的,自己可以上外网还不行,需要别人上外网才可以看到我文章中的图片,这也太难了
114 0
|
JavaScript 安全 Linux
Typora+PicGo+GitHub-Gitee-SM.MS打造专属图床,提升编写文档效率
Typora+PicGo+GitHub-Gitee-SM.MS打造专属图床,提升编写文档效率
150 0
|
数据可视化
R沟通|部署 bookdown 文件到 GitHub 上
R沟通|部署 bookdown 文件到 GitHub 上
91 0
|
数据可视化 Apache 区块链
最新!GitHub 推出 ReadME 项目,让世界听到开发者的声音
Coding 通常被视为一项单独的活动,但实际上,这是由一小群开源维护者、贡献者和团队领导的全球最大的社区活动。这些“无名英雄”常常需要花费大量的时间来构建软件、修复 issues、解答问题和管理社区,而往往没有得到资金资金或认可。开源项目的使用者与维护者的比例可以达到 2,000: 1 的极度不平衡。
158 0
最新!GitHub 推出 ReadME 项目,让世界听到开发者的声音
|
数据可视化 API Android开发
爱了爱了🌹,这个VSCode插件极大提升你的工mo作yu效率 | 创作者训练营
最近沉迷掘金不能自拔,一整天都在掘金上面刷呀刷,同时还在一边使用VSCode码代码。我突发奇想,能不能把掘金塞进VSCode里呢?在做之前,当然要做一下市场调查,市面上有另外两个掘金相关的插件,但完成度和使用体验我都不太满意。
171 0
爱了爱了🌹,这个VSCode插件极大提升你的工mo作yu效率 | 创作者训练营
|
前端开发 JavaScript Java
8 个你必须要掌握的 GitHub 实用技巧!.md
8 个你必须要掌握的 GitHub 实用技巧!.md
8 个你必须要掌握的 GitHub 实用技巧!.md