GitHub上README.md编写教程(基本语法)

2024-02-07 14:18

本文主要是介绍GitHub上README.md编写教程(基本语法),希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

主要参考:GitHub上README.md编写教程(基本语法)_无名的一棵小树-CSDN博客_readme.md语法 


一、标题写法:

第一种方法:标题文本下方加“=”号或“--”号

1、在文本下面加上等于号“=” ,那么上方的文本就变成了大标题。等于号的个数无限制,但一定要大于0个。
2、在文本下面加上下划线“--”,那么上方的文本就变成了中标题,同样的下划线个数无限制。
3、要想输入“=”号,上面有文本而不让其转化为大标题,则需要在“=”行与标题行之间加一个空行。

第二种方法(推荐):在标题文本前加“#”号,在“#”与标题之间需要有空格

该方法便于标题的等级划分,共可划分为6个等级。不同等级的标题前有不同个数的“#”号。一级标题有一个 #,二级标题有两个# ,以此类推。
例如:
# 一级标题  
## 二级标题  
### 三级标题  
#### 四级标题  
##### 五级标题  
###### 六级标题 

二、正文编辑的基本语法  

1. 换行

直接回车不能换行,可通过以下三种方式实现换行:

方法1:在行末尾添加<br>

方法2:在行末尾添加两个空格。(推荐)

方法3:在两行之间插入一个空行。

2. 强调

 我们可以使用下面的方式给我们的文本添加强调的效果

1)斜体格式:
 

*强调*  (示例:斜体)  _强调_  (示例:斜体)  

2)粗体格式
 

**加重强调**  (示例:粗体)  __加重强调__ (示例:粗体)  

3)粗斜体格式
 

***特别强调*** (示例:粗斜体)  
___特别强调___  (示例:粗斜体)  


3、代码  

在代码行前后添加“``”。注:“`”符号是tab键与“1!”键之间的键。示例:

`hello world`  

4. 代码片段

我们需要在代码片段的前后用“```”标记。``` 不是三个单引号,而是数字1左边,Tab键上面的键。

要实现语法高亮那么只要在 ``` 之后加上你的编程语言即可(忽略大小写)。

c++语言可以写成c++也可以是cpp。看代码:

实际显示效果: 

 

4、表格 (建议在表格前空一行,否则可能影响表格无法显示)

表头  | 表头  | 表头---- | ----- | ------  单元格内容  | 单元格内容 | 单元格内容 单元格内容  | 单元格内容 | 单元格内容   

5. 图片

该图片需要在网络上存在,然后用以下格式显示图片:![图片名称](图片网址)。

注意,“!”与 “[]”与“()”之间不能有空格。示例如下:

![图片名称](https://www.baidu.com/img/bd_logo1.png)  

如果你想达到鼠标悬停显示提示信息,那么可以仿照前面介绍的文本中的方法,就是这样:

![图片名称](https://www.baidu.com/img/bd_logo1.png “提示信息”)  

6. 链接。

添加链接并给链接添加替换文本,格式如下: 
[替换文本](https://www.baidu.com/)    


7. 无序列表  

格式:在每隔条目之前添加“*”号,“*”与正文之间需要有空格。在显示时,“*”会变为黑点。

多级圆点列表:就是在“*”之前多加一个Tab。

示例:
* 1. 项目1  
* 2. 项目2  
* 3. 项目3  


8.块引用有多级结构

> 数据结构
>> 树
>>> 二叉树
>>>> 平衡二叉树
>>>>> 满二叉树

参考:

GitHub上README.md教程_Kaitiren的专栏-CSDN博客

GitHub - guodongxiaren/README: README文件语法解读,即Github Flavored Markdown语法介绍

这篇关于GitHub上README.md编写教程(基本语法)的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/687991

相关文章

Go语言数据库编程GORM 的基本使用详解

《Go语言数据库编程GORM的基本使用详解》GORM是Go语言流行的ORM框架,封装database/sql,支持自动迁移、关联、事务等,提供CRUD、条件查询、钩子函数、日志等功能,简化数据库操作... 目录一、安装与初始化1. 安装 GORM 及数据库驱动2. 建立数据库连接二、定义模型结构体三、自动迁

ModelMapper基本使用和常见场景示例详解

《ModelMapper基本使用和常见场景示例详解》ModelMapper是Java对象映射库,支持自动映射、自定义规则、集合转换及高级配置(如匹配策略、转换器),可集成SpringBoot,减少样板... 目录1. 添加依赖2. 基本用法示例:简单对象映射3. 自定义映射规则4. 集合映射5. 高级配置匹

深度解析Spring AOP @Aspect 原理、实战与最佳实践教程

《深度解析SpringAOP@Aspect原理、实战与最佳实践教程》文章系统讲解了SpringAOP核心概念、实现方式及原理,涵盖横切关注点分离、代理机制(JDK/CGLIB)、切入点类型、性能... 目录1. @ASPect 核心概念1.1 AOP 编程范式1.2 @Aspect 关键特性2. 完整代码实

Java Web实现类似Excel表格锁定功能实战教程

《JavaWeb实现类似Excel表格锁定功能实战教程》本文将详细介绍通过创建特定div元素并利用CSS布局和JavaScript事件监听来实现类似Excel的锁定行和列效果的方法,感兴趣的朋友跟随... 目录1. 模拟Excel表格锁定功能2. 创建3个div元素实现表格锁定2.1 div元素布局设计2.

SpringBoot连接Redis集群教程

《SpringBoot连接Redis集群教程》:本文主要介绍SpringBoot连接Redis集群教程,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录1. 依赖2. 修改配置文件3. 创建RedisClusterConfig4. 测试总结1. 依赖 <de

SQL BETWEEN 语句的基本用法详解

《SQLBETWEEN语句的基本用法详解》SQLBETWEEN语句是一个用于在SQL查询中指定查询条件的重要工具,它允许用户指定一个范围,用于筛选符合特定条件的记录,本文将详细介绍BETWEEN语... 目录概述BETWEEN 语句的基本用法BETWEEN 语句的示例示例 1:查询年龄在 20 到 30 岁

mysql中insert into的基本用法和一些示例

《mysql中insertinto的基本用法和一些示例》INSERTINTO用于向MySQL表插入新行,支持单行/多行及部分列插入,下面给大家介绍mysql中insertinto的基本用法和一些示例... 目录基本语法插入单行数据插入多行数据插入部分列的数据插入默认值注意事项在mysql中,INSERT I

mapstruct中的@Mapper注解的基本用法

《mapstruct中的@Mapper注解的基本用法》在MapStruct中,@Mapper注解是核心注解之一,用于标记一个接口或抽象类为MapStruct的映射器(Mapper),本文给大家介绍ma... 目录1. 基本用法2. 常用属性3. 高级用法4. 注意事项5. 总结6. 编译异常处理在MapSt

Nexus安装和启动的实现教程

《Nexus安装和启动的实现教程》:本文主要介绍Nexus安装和启动的实现教程,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、Nexus下载二、Nexus安装和启动三、关闭Nexus总结一、Nexus下载官方下载链接:DownloadWindows系统根

MyBatis ResultMap 的基本用法示例详解

《MyBatisResultMap的基本用法示例详解》在MyBatis中,resultMap用于定义数据库查询结果到Java对象属性的映射关系,本文给大家介绍MyBatisResultMap的基本... 目录MyBATis 中的 resultMap1. resultMap 的基本语法2. 简单的 resul