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

相关文章

Window Server创建2台服务器的故障转移群集的图文教程

《WindowServer创建2台服务器的故障转移群集的图文教程》本文主要介绍了在WindowsServer系统上创建一个包含两台成员服务器的故障转移群集,文中通过图文示例介绍的非常详细,对大家的... 目录一、 准备条件二、在ServerB安装故障转移群集三、在ServerC安装故障转移群集,操作与Ser

windos server2022的配置故障转移服务的图文教程

《windosserver2022的配置故障转移服务的图文教程》本文主要介绍了windosserver2022的配置故障转移服务的图文教程,以确保服务和应用程序的连续性和可用性,文中通过图文介绍的非... 目录准备环境:步骤故障转移群集是 Windows Server 2022 中提供的一种功能,用于在多个

利用Python编写一个简单的聊天机器人

《利用Python编写一个简单的聊天机器人》这篇文章主要为大家详细介绍了如何利用Python编写一个简单的聊天机器人,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 使用 python 编写一个简单的聊天机器人可以从最基础的逻辑开始,然后逐步加入更复杂的功能。这里我们将先实现一个简单的

使用Python进行文件读写操作的基本方法

《使用Python进行文件读写操作的基本方法》今天的内容来介绍Python中进行文件读写操作的方法,这在学习Python时是必不可少的技术点,希望可以帮助到正在学习python的小伙伴,以下是Pyth... 目录一、文件读取:二、文件写入:三、文件追加:四、文件读写的二进制模式:五、使用 json 模块读写

龙蜥操作系统Anolis OS-23.x安装配置图解教程(保姆级)

《龙蜥操作系统AnolisOS-23.x安装配置图解教程(保姆级)》:本文主要介绍了安装和配置AnolisOS23.2系统,包括分区、软件选择、设置root密码、网络配置、主机名设置和禁用SELinux的步骤,详细内容请阅读本文,希望能对你有所帮助... ‌AnolisOS‌是由阿里云推出的开源操作系统,旨

PyTorch使用教程之Tensor包详解

《PyTorch使用教程之Tensor包详解》这篇文章介绍了PyTorch中的张量(Tensor)数据结构,包括张量的数据类型、初始化、常用操作、属性等,张量是PyTorch框架中的核心数据结构,支持... 目录1、张量Tensor2、数据类型3、初始化(构造张量)4、常用操作5、常用属性5.1 存储(st

Java操作PDF文件实现签订电子合同详细教程

《Java操作PDF文件实现签订电子合同详细教程》:本文主要介绍如何在PDF中加入电子签章与电子签名的过程,包括编写Word文件、生成PDF、为PDF格式做表单、为表单赋值、生成文档以及上传到OB... 目录前言:先看效果:1.编写word文件1.2然后生成PDF格式进行保存1.3我这里是将文件保存到本地后

windows系统下shutdown重启关机命令超详细教程

《windows系统下shutdown重启关机命令超详细教程》shutdown命令是一个强大的工具,允许你通过命令行快速完成关机、重启或注销操作,本文将为你详细解析shutdown命令的使用方法,并提... 目录一、shutdown 命令简介二、shutdown 命令的基本用法三、远程关机与重启四、实际应用

python库fire使用教程

《python库fire使用教程》本文主要介绍了python库fire使用教程,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧... 目录1.简介2. fire安装3. fire使用示例1.简介目前python命令行解析库用过的有:ar

LinuxMint怎么安装? Linux Mint22下载安装图文教程

《LinuxMint怎么安装?LinuxMint22下载安装图文教程》LinuxMint22发布以后,有很多新功能,很多朋友想要下载并安装,该怎么操作呢?下面我们就来看看详细安装指南... linux Mint 是一款基于 Ubuntu 的流行发行版,凭借其现代、精致、易于使用的特性,深受小伙伴们所喜爱。对