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

article/2025/9/23 14:52:38

主要参考: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语法介绍


http://chatgpt.dhexx.cn/article/sEBwvXWY.shtml

相关文章

README.md文件

引言&#xff1a; README.md文件用的是Markdown编写的&#xff0c;所有我们先来看看Markdown的语法 首先在github上面某个项目里面创建一个README.md,然后在里面区编辑内容&#xff0c;如图&#xff0c; 点击edit file在下面输入内容&#xff0c;然后切换到preview changes进…

GitHub上README.md教程

最近对它的README.md文件颇为感兴趣。便写下这贴&#xff0c;帮助更多的还不会编写README文件的同学们。 README文件后缀名为md。md是markdown的缩写&#xff0c;markdown是一种编辑博客的语言。用惯了可视化的博客编辑器&#xff08;比如CSDN博客&#xff0c;囧&#xff09;&a…

README文档的规范写法

看过很多开源库&#xff0c;发现有些库的文档写的一团糟&#xff0c;有的甚至就是一个标题&#xff0c;让你自己下载之后运行&#xff0c;自己摸索&#xff0c;看的很头疼。而那些使用量大的库的文档写的很标准&#xff0c;很详细&#xff0c;看的很舒服。 README文档写的好的…

你真的知道README吗?

目录 README MarkDown README的要素 API文档 总结 README是我们开发项目必备的文件&#xff0c;之前没有认真的研究过&#xff0c;都是大概的了解下&#xff0c;没想到里面也是一门大学问&#xff0c;话不多说&#xff0c;直接码起来。 README README是项目自我描述文件…

软件项目规范(1):README文件的基本写作规范

看Github的开源项目&#xff0c;我们都能看到README.md文件的身影。 有不少同学都喜欢将自己的项目上传到Git托管起来&#xff0c;但是总能发现一个问题&#xff1a;明明自己这个项目挺有市场的啊&#xff0c;怎么这个代码放上去&#xff0c;就显得很“非官方”&#xff01; …

Java基础-快速入门

Java基础 Java基础-快速入门java简介java介绍java版本为什么学习javajava特点java优缺点优点缺点 java应用范围适用于不适用于 java规范java平台 安装JDK第一个Java程序安装并使用EclipseEclipse介绍Eclipse安装使用Eclipse创建第一个项目 安装Eclipse插件 Java基础-快速入门 …

Java-基础入门

1.发展历史 1995年Sun公司发布Java1.0版本 1997年发布Java1.1版本 1998年发布Java1.2版本 2000年发布Java1.3版本 2002年发布Java1.4版本 2004年发布Java1.5版本 2006年发布Java1.6版本 2009年Oracle甲骨文公司收购Sun公司&#xff0c;并于2011发布Java1.7版本 2014年…

java入门笔记

1. Java相关概念 编程&#xff1a;用倾向于自然语言的方式编写指令代码的过程 编译&#xff1a;将自然语言指令代码转化为机器语言&#xff08;二进制&#xff09;的过程系统差异化&#xff1a;为了用不同类型的芯片实现相同的功能&#xff0c;就需要用不同的指令代码操作不同…

一、Java基础入门

一、java简介 1.1 前言 Java语言是美国Sun公司(stanford University Network),在1995年推出的高级编程语言。所谓编程语言是计算机的语言&#xff0c;人们可以使用编程语言对计算机下达命令&#xff0c;让计算机完成人们需要的功能。 1996年1月&#xff0c;Sun公司发布了Java的…

Java基础及入门

一、软件开发基础 1.什么是JavaEE JavaEE是一门接收来自客户端的请求&#xff0c;并通过响应返回给客户端数据的技术。 2.JavaEE理解图 2.常用的开发语言 二、Java开发环境搭建 1.什么是JDK及JRE 安装JRE的目的是什么&#xff1f;&#xff08;是为了编译代码&#xff09; JDK&…

java入门的基础(入门必读)

Java入门基础 什么是java程序开发Java的运行环境开发Java程序的步骤java的基本框架数据类型、变量数据类型变量变量名命名规则 运算符关系运算符逻辑运算符算术运算符 扫描仪的使用if选择结构多重if选择结构嵌套if选择结构 switch选择结构循环结构while循环结构do-while循环结构…

JAVA基础学习入门

JAVA入门之基本语法&#xff08;一&#xff09; 最近开始复习JAVA语言为找工作做准备&#xff0c;方便以后再次复习或者用到的时候回顾。先是从JAVA的基本语法学起&#xff0c;因为有c和c语言的基础知识铺垫&#xff0c;所以这部分的笔记会比较粗略&#xff0c;毕竟语言都是贯…

Java基础入门(六)

Java基础入门&#xff08;六&#xff09; 1 Debug调试1.1 Debug概述1.2 Debug操作流程1.2.1 设置断点1.2.2 运行加了断点的程序1.2.3 Debugger窗口和Console窗口1.2.4 分步执行1.2.5 取消断点1.2.6 结束Debug1.2.7 注意事项 2.基础中常用的类2.1 Random随机数2.2 Scanner获取用…

Java基础之入门(一)

文章目录 Java帝国的诞生1. Java初生2. Java的发展3. Java特性和优势4. JVM、JRE、JDK5. Java程序的运行机制6.注释7. 标识符和关键字7.1 关键字7.2 标识符 8. 数据类型8.1 基本数据类型8.1.1 字符案例8.1.2 整型案例8.1.3 浮点型案例 8.2 引用数据类型 9. 类型转换9.1 转换方式…

java入门基础

语法基础 变量和常量 字符串 tring 类型是引用类型 字符串拼接可以直接用加号连接 自动类型转换 向上类型转换&#xff0c;是小类型到大类型的转换。 和C语音一样 int类型可以自动转换为double 但是double需要强制转换才能转换为int 强制类型转换 向下类型转换&…

JAVA基础入门学习

书籍推荐和视频推荐 Java核心卷I java核心卷II可以买也可以不买。java核心卷I只看前9章&#xff0c;其他不用看。身边同学都认为这本书不适合初学者&#xff0c;但是如果你之前看过java学习视频&#xff0c;那么这本书很适合你。这本书主要让你对java知识有个系统的学习&…

JAVA入门及基础

随着技术的不断发展&#xff0c;编程语言的种类也在越来越多&#xff0c;由全国知名TIOBE编程语言社区发布的编程语言排行榜来看&#xff0c;我们的JAVA在近两年来仍然占据榜二榜三&#xff0c;那么能一直稳居前排必然是有他的原因的&#xff1a;我们的JAVA具有使用广泛&#x…

《Java基础入门》第三版--黑马程序员课后习题(编程部分)

第 1 章 Java 开发入门 第 2 章 Java 编程基础 1. 编写程序,计算13…99的值,要求如下&#xff1a; (1)使用循环语句实现1~99的遍历 (2)在遍历过程中,通过条件判断当前的数是否为奇数,如果是就累加,否则不加。 public class getSum { 2 public static void main(String[] ar…

《Java基础入门》笔记——01 Java初步

1 关于Java 1.1 Java的发展简史 Java之父——Gosling(高司令)98年&#xff0c;Java2企业平台J2EE发布99年发布J2SE(标准版)、J2EE(企业版)、J2ME(微型版)04年&#xff0c;发布JavaSE5.009年&#xff0c;Oracle收购Sun14年&#xff0c;发布JavaSE8 1.2 Java语言的特点 简单。…

java基础入门(完整详细版)

前言&#xff1a; 这篇教程对没学过java的完全适用这篇教程是一个学习方向的引导&#xff0c;且只针对基础入门。 一.入门篇 1.安装JDK的运行环境 1.1 下载JDK 直接官网下载&#xff1a;http://www.oracle.com/&#xff1b;链接&#xff1a;网盘安装JDK点击就可以下载(推荐…