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

相关文章

Python 安装和配置flask, flask_cors的图文教程

《Python安装和配置flask,flask_cors的图文教程》:本文主要介绍Python安装和配置flask,flask_cors的图文教程,本文通过图文并茂的形式给大家介绍的非常详细,... 目录一.python安装:二,配置环境变量,三:检查Python安装和环境变量,四:安装flask和flas

Spring Security基于数据库的ABAC属性权限模型实战开发教程

《SpringSecurity基于数据库的ABAC属性权限模型实战开发教程》:本文主要介绍SpringSecurity基于数据库的ABAC属性权限模型实战开发教程,本文给大家介绍的非常详细,对大... 目录1. 前言2. 权限决策依据RBACABAC综合对比3. 数据库表结构说明4. 实战开始5. MyBA

Ubuntu中远程连接Mysql数据库的详细图文教程

《Ubuntu中远程连接Mysql数据库的详细图文教程》Ubuntu是一个以桌面应用为主的Linux发行版操作系统,这篇文章主要为大家详细介绍了Ubuntu中远程连接Mysql数据库的详细图文教程,有... 目录1、版本2、检查有没有mysql2.1 查询是否安装了Mysql包2.2 查看Mysql版本2.

Elasticsearch 在 Java 中的使用教程

《Elasticsearch在Java中的使用教程》Elasticsearch是一个分布式搜索和分析引擎,基于ApacheLucene构建,能够实现实时数据的存储、搜索、和分析,它广泛应用于全文... 目录1. Elasticsearch 简介2. 环境准备2.1 安装 Elasticsearch2.2 J

Linux系统中卸载与安装JDK的详细教程

《Linux系统中卸载与安装JDK的详细教程》本文详细介绍了如何在Linux系统中通过Xshell和Xftp工具连接与传输文件,然后进行JDK的安装与卸载,安装步骤包括连接Linux、传输JDK安装包... 目录1、卸载1.1 linux删除自带的JDK1.2 Linux上卸载自己安装的JDK2、安装2.1

用js控制视频播放进度基本示例代码

《用js控制视频播放进度基本示例代码》写前端的时候,很多的时候是需要支持要网页视频播放的功能,下面这篇文章主要给大家介绍了关于用js控制视频播放进度的相关资料,文中通过代码介绍的非常详细,需要的朋友可... 目录前言html部分:JavaScript部分:注意:总结前言在javascript中控制视频播放

Linux卸载自带jdk并安装新jdk版本的图文教程

《Linux卸载自带jdk并安装新jdk版本的图文教程》在Linux系统中,有时需要卸载预装的OpenJDK并安装特定版本的JDK,例如JDK1.8,所以本文给大家详细介绍了Linux卸载自带jdk并... 目录Ⅰ、卸载自带jdkⅡ、安装新版jdkⅠ、卸载自带jdk1、输入命令查看旧jdkrpm -qa

Java使用Curator进行ZooKeeper操作的详细教程

《Java使用Curator进行ZooKeeper操作的详细教程》ApacheCurator是一个基于ZooKeeper的Java客户端库,它极大地简化了使用ZooKeeper的开发工作,在分布式系统... 目录1、简述2、核心功能2.1 CuratorFramework2.2 Recipes3、示例实践3

springboot简单集成Security配置的教程

《springboot简单集成Security配置的教程》:本文主要介绍springboot简单集成Security配置的教程,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,... 目录集成Security安全框架引入依赖编写配置类WebSecurityConfig(自定义资源权限规则

MySQL Workbench 安装教程(保姆级)

《MySQLWorkbench安装教程(保姆级)》MySQLWorkbench是一款强大的数据库设计和管理工具,本文主要介绍了MySQLWorkbench安装教程,文中通过图文介绍的非常详细,对大... 目录前言:详细步骤:一、检查安装的数据库版本二、在官网下载对应的mysql Workbench版本,要是