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

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


目录
相关文章
|
存储 开发工具 Docker
Docker数据目录迁移解决方案
在docker的使用中随着下载镜像越来越多,构建镜像、运行容器越来越多, 数据目录必然会逐渐增大;当所有docker镜像、容器对磁盘的使用达到上限时,就需要对数据目录进行迁移。
13606 1
|
算法 Unix API
指数退避(Exponential backoff)在网络请求中的应用
## 一、背景 最近做云服务 API 测试项目的过程中,发现某些时候会大批量调用 API,从而导致限流的报错。在遇到这种报错时,传统的重试策略是每隔一段时间重试一次。但由于是固定的时间重试一次,重试时又会有大量的请求在同一时刻涌入,会不断地造成限流。 这让我回想起两年前在查阅[Celery Task 文档](http://docs.celeryproject.org/en/latest
13876 1
|
jenkins Java Shell
使用 Docker 安装 Jenkins 并实现项目自动化部署
Jenkins 是一款开源的持续集成(DI)工具,广泛用于项目开发,能提供自动构建,测试,部署等功能。作为领先的开源自动化服务器,Jenkins 提供了数百个插件来支持构建、部署和自动化任何项目。
36319 3
使用 Docker 安装 Jenkins 并实现项目自动化部署
|
数据可视化 算法 API
【README.md 指南 】如何编写 README.md:打造出色的开源项目文档
【README.md 指南 】如何编写 README.md:打造出色的开源项目文档
5559 0
|
Java Linux Windows
Java“Could Not Create Java Virtual Machine”解决
当在Java中遇到“Could Not Create Java Virtual Machine”错误时,通常是由于内存设置不当、Java版本不兼容、类路径错误或操作系统限制等原因导致JVM无法启动。解决方法包括调整内存参数、确认Java版本兼容性、检查类路径和启动参数、以及检查用户权限和文件系统。
6648 1
|
JSON 缓存 Java
优雅至极!Spring Boot 3.3 中 ObjectMapper 的最佳实践
【10月更文挑战第5天】在Spring Boot的开发中,ObjectMapper作为Jackson框架的核心组件,扮演着处理JSON格式数据的核心角色。它不仅能够将Java对象与JSON字符串进行相互转换,还支持复杂的Java类型,如泛型、嵌套对象、集合等。在Spring Boot 3.3中,通过优雅地配置和使用ObjectMapper,我们可以更加高效地处理JSON数据,提升开发效率和代码质量。本文将从ObjectMapper的基本功能、配置方法、最佳实践以及性能优化等方面进行详细探讨。
1119 2
|
IDE Java 编译器
lombok编译遇到“找不到符号的问题”
【9月更文挑战第18天】当使用 Lombok 遇到 “找不到符号” 的问题时,可能是由于 Lombok 未正确安装、编译器不支持、IDE 配置不当或项目构建工具配置错误。解决方法包括确认 Lombok 安装、编译器支持,配置 IDE 和检查构建工具配置。通过这些步骤通常可解决问题,若问题仍存在,建议检查项目配置和依赖,或查看日志获取更多信息。
5848 2
|
存储
好看又规范的Github Readme 制作指南
本文是关于制作规范且外观吸引人的GitHub README文件的指南,包括了README的基本结构、美化技巧,以及如何使用Markdown格式、徽标和图片来增强文档的可读性和吸引力。
1489 0
|
Ubuntu 安全 网络协议

热门文章

最新文章