开源项目的 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

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


目录
相关文章
个人GitHub的md规范
个人GitHub的md规范
82 0
|
2月前
|
Rust JavaScript
从零开始写一套广告组件【三】编写README.md
现在项目已经有了,但是我们还没有正式的介绍我们的项目和添加 ` License` 文件,这一章我们就一起来看看如何写一个**README.md**
39 5
从零开始写一套广告组件【三】编写README.md
|
3月前
|
存储
好看又规范的Github Readme 制作指南
本文是关于制作规范且外观吸引人的GitHub README文件的指南,包括了README的基本结构、美化技巧,以及如何使用Markdown格式、徽标和图片来增强文档的可读性和吸引力。
366 0
|
4月前
GitHub——README.md挂件如何生成
使用`shields.io`即可生成github的markdown的挂件
33 0
GitHub——README.md挂件如何生成
|
3月前
|
安全 Ubuntu 测试技术
庆祝 Go 开源发布十四周年!
庆祝 Go 开源发布十四周年!
|
6月前
|
安全 前端开发 PHP
Upload-labs 通关解析(上)
Upload-labs 靶场通关解析(上)
|
6月前
|
数据可视化 算法 API
【README.md 指南 】如何编写 README.md:打造出色的开源项目文档
【README.md 指南 】如何编写 README.md:打造出色的开源项目文档
3022 0
|
6月前
|
程序员 数据库
十一假期,分享几个好玩儿的GitHub项目
十一假期,分享几个好玩儿的GitHub项目
59 0
|
11月前
|
SQL 安全 Java
阿里大牛1个月肝出一份35万字Security实战笔记,GitHub标星47k+
很多时候,一个系统的安全性完全取决于系统开发人员的安全意识。例如,在我们从未听过SQL注入时,如何意识到要对SQL注入做防护?关于Web系统安全的攻击方式非常多,诸如XSS、CSRF等,未来还会暴露出更多的攻击方式,我们只有在充分了解其攻击原理后,才能提出完善而有效的防护策略。在笔者看来,学习Spring Security并非局限于降低Java应用的安全开发成本,通过Spring Security了解常见的安全攻击手段以及对应的防护方法也尤为重要,这些是脱离具体开发语言而存在的。
阿里大牛1个月肝出一份35万字Security实战笔记,GitHub标星47k+
|
JavaScript 安全 Linux
Typora+PicGo+GitHub-Gitee-SM.MS打造专属图床,提升编写文档效率
Typora+PicGo+GitHub-Gitee-SM.MS打造专属图床,提升编写文档效率
171 0