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

README.md 完全指南:Markdown 语法+实例 掌握这些Markdown语法和使用技巧,README颜值飙升!✨ 阅读详情
AI摘要

本文详细介绍了GitHub README.md文件的编写技巧,包括标题样式、换行、强调、代码块、表格、图片、链接、列表等,帮助读者掌握Markdown语言在项目文档中的应用。

主要参考:GitHub上README.md编写教程(基本语法)_无名的一棵小树-优快云博客_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的专栏-优快云博客

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

GitHub上README写法暨GFM语法解读 转载请保留原作者guodongxiaren的原文地址。 自从开始玩GitHub以来,就越来越感觉它有爱。最近对它的README.md文件颇为感兴趣。便写下这贴,帮助更多的还不会编写README文件的同学们。 README文件后缀名为md。md是markdown的缩写,markdown是一种编辑博客的语言。用惯了可视化的博客编辑器(比如优快云博客,囧),这种编程式的博客编辑方案着实... 阅读详情

相关推荐

[学习github]如何高效入门Github/GitHub中的README.MD文件编写语法

github https://github.com/geeeeeeeeek/git-recipes github的使用 一、注册github账号。 请自行进入https://github.com进行注册。 二、安装git及一些基本设置。 1.安装git sudoapt-getinstallgit 2.设置github账号信息 gitconfig--globalus...

开源节流 1779

原来Github上的README.md文件这么有意思——Markdown语言详解

转载请注明出处:http://blog.csdn.net/zhaokaiqiang1992    之前一直在使用github,也在上面分享了不少的项目和Demo,每次创建新项目的时候,使用的都是默认的README.md文件,也不曾对这个文件有过什么了解。但是在看到别人写的项目的README.md里面竟然有图片、链接什么的,就感到很好奇,这效果是什么加上去的?于是便查了一下资料,结果,竟迁出了一门从

赵凯强 14万+

教程:readme.md文件基础使用

1.如何在readme.md文件中添加图片: 将图片文件上传到github项目仓库的文件夹下,上传成功后,打开上传的图片,在地址栏得到图片链接并复制,编辑插入到README.md文件中: ![Image text](https://github.com/your_github/address/blob/master/image/1.png) 前面是其特定格式,小括号内是github图片的地址; 最后提交并保存写好的README.md文件即可。 2.README.md文件中 markdown语法 插入超链接

人生是一场修行 9528

README.md文件的作用及其文件内容的语法

README.md文件一般出现在项目的根目录下,其作用是对项目的主要信息进行描述。 如果一个项目你很长时间都没有动,突然你需要修改这个项目,那么通过README.md中对项目的描述能让你快速的再次上手; 或者别人拿到你的项目也能通过README.md文件的描述快速的了解该项目。 ## README.md的语法 ### 1.标题,几个“#”就表示几级标题,注意最后一个“#”后面有一个空格: # 一级标题 ## 二级标题 ### 三级标题 #错误语法 对应效果:图1 ### 2.文字格式 *斜.

月影WEB的博客 1万+

[SWPUCTF 2018]SimplePHP--一道简单的Phar反序列化题目

题目就不贴了,直接给出利用链①:echo会触发__toString魔术方法,所以这里的$this->test应该是Show类实例化的对象show②:这里应该使$this->str['str']为Test类实例化后的对象test,然后test->source会触发__get魔术方法(因为Test类没有名为source的成员变量,所以会触发get魔术方法,并且$key=source)③④:调用get方法,$...

Dream' 1258

逐行逐句进一步了解SurroundOcc(一)

通过分析中的模型构建过程,理解了从配置文件到模型实例化的整个流程。构建过程的核心是通过build和等函数,逐步将配置文件解析并生成模型的各个模块对象,最终组合成一个完整的模型结构。这一过程涉及多个类和函数的调用,其中函数是生成对象的关键,它能够从配置字典中提取必要信息并生成对应的类实例。

lovely_yoshino的博客 8111

README.md文件

引言: README.md文件用的是Markdown编写的,所有我们先来看看Markdown的语法 首先在github上面某个项目里面创建一个README.md,然后在里面区编辑内容,如图, 点击edit file在下面输入内容,然后切换到preview changes进行预览,好了废话不说了,下面进入基本语法的练习 一、标题 语法:# 文字内容 备注:一个#代表一级标题,2个#代表二级标...

qq_37493425的博客 1万+

Xilinx GTY Transceiver时钟方案与功耗优化实践

本文详细解析了Xilinx GTY Transceiver的时钟方案设计与功耗优化实践,涵盖从基础配置到高速24.33024Gbps和中速10.1376Gbps的实战案例。通过Transceivers Wizard的IP设计技巧和动态功耗优化方法,帮助工程师有效降低FPGA系统功耗,提升高速串行通信的稳定性与效率。

weixin_28736355的博客 228

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

今天在编写github中的readme.md文档时,发现自己写的和别人写的样式完全不一样,自己的好难看,于是百度了一番,很多都是转载的别人13年的博客,其中还发现一片17年写的原创,本以为发现了一个新的文章,结果发现其实就是转载的别人13年的博客,一个字都没修改居然可以编辑为原创,真心服了哪位仁兄了,本来打算在他文章底部评论的,最后想想算了吧。一番百度后,根据他人的博客重新归正了下。 参考博客: https://blog.csdn.net/zhao_jing_bo/article/details/680

码蝗的博客 1370

FPGA数字下变频实战:用Vivado DDS IP核实现IQ采样与频率校正(附MATLAB仿真对比)

本文提供了一份基于Vivado DDS IP核实现FPGA数字下变频(DDC)的完整工程指南。详细阐述了IQ采样的原理、DDC链路构建、DDS频率校正的工程实现,并重点介绍了如何利用MATLAB搭建黄金参考模型进行全链路仿真与对比验证,分享了关键的调试技巧与性能优化建议。

t1u2v的博客 810

【学习笔记】计算机网络 第八章 无线局域网(WLAN)

计算机网络 第八章 无线局域网(WLAN)

Vera_shsf的博客 1242

GitHub中README.md语法解读

GitHub的README.md使用的MarkDown语法非常好用,转载这篇帖子与大家分享。 原文地址: http://blog.csdn.net/guodongxiaren/article/details/23690801 --------------------------------------------------------------------

李旭的专栏 4386

华为昇腾Atlas200DK. CANN模型推理——目标检测结果不对(无检测结果)的问题解决

目录前言问题描述问题排查1.后处理模块问题排查2.预处理模块问题排查3.模型问题排查4.算法bug问题排查5.AI板卡问题排查6.模型精度问题排查6.模型推理问题解决:模型输入数据与预处理不同后记 前言 上周我在华为昇腾Atlas200DK中部署nanodet和yolov5时,出现了目标检测结果不对(没有检测到任何物体),困扰了整整三天,最后找到原因并圆满解决,在这里记录一下debug过程。 以上测试均在python中完成。 问题描述 第一天上午,我首先将nanodet由pytorch的.pth模型转换为.

qq_41035283的博客 5604

Github上的README.md基本写法

本人今天也是第一次接触markdown,通过一天的各种尝试和探究,总结出了一些基本的用法,我就分享在这里: 标题写法 标题分为六个等级,显示的文本大小会依次减小。依次用一到六个 # 来区分等级,一级标题有一个 #,依次类推。注意的是在 # 和标题之间有一个空格。 一级到六级标题如下:# 这是一级标题 ## 这是二级标题 ### 这是三级标题 #### 这是四级标题 ##### 这是五级标题 ##...

weixin_42795141的博客 5711

【并发编程五】c++进程通信——共享内存(shared memmory)

现代操作系统,对于内存管理,采⽤的是虚拟内存技术,也就是每个进程都有⾃⼰独⽴的虚拟内存空间,不同进程的虚拟内存映射到不同的物理内存中。所以,即使进程 A中 和 进程 B中 的虚拟地址是⼀样的,其实访问的是不同的物理内存地址,对于数据的增删查改互不影响。这样这个进程写⼊的东⻄,另外⼀个进程⻢上就能看到了,都不需要拷⻉来拷⻉去,传来传去,⼤⼤提⾼了进程间通信的速度。⽤了共享内存通信⽅式,带来新的问题,那就是如果多个进程同时修改同⼀个共享内存,很有可能就冲突了。那共享内存的⽅式,就很好的解决了这⼀问题。

junxuezheng的博客 1万+

YOLOv8推理程序

YOLOv8单独推理,有时候我们自定义的模块算子无法正常转换为其他框架,而且需要做成应用,因此需要一个单独推理的程序,返回的是识别后的照片还有各个类别及其对应数量。文章最后给出Flask封装为Server以及调用的实例还有Client请求代码,支持几十路多线程并发,只需加载一次模型,后边推理即可。

AIOT魔法师 698

gitHub中readme.md编写语法

1.标题表示法:分为六个等级,显示的文本大小依次减小。不同等级之间是以井号 # 的个数来标识的。一级标题有一个 #,二级标题有两个# ,以此类推。注意:#与标题名中间的空格 # 一级标题 ## 二级标题 ### 三级标题 #### 四级标题 ##### 五级标题 ###### 六级标题 2.换行: 在你想换行的地方加一个&lt...

Alisane的博客 3313

IEM模型,地表粗糙度模拟

利用微波反演土壤水分时候,利用IEM模型可以实现对随机地表的模拟

【转】GitHub上README.md教程

本文是转载文章,文章的来源:csdn博客 博主:果冻虾仁 文章: GitHub上README写法暨GFM语法解读 博文地址:https://blog.csdn.net/guodongxiaren/article/details/23690801 转载请保留原作者guodongxiaren的原文地址: http://blog.csdn.net/guodongxiaren/article/details/23690801 本文在GitHub的演示地址: https://github.com/gu.

sinolover的专栏 2075

TMS_WebGMaps_1.9.8.0_Full_Source

TMS_WebGMaps_1.9.8.0_Full_Source 全源码 delphi cbuilder

OV9734 DATASHEET,完整规格书

OV9734完整规格书,包括电气参数,尺寸规格,寄存器配置表等

GitHub上README.md教程

最近对它的README.md文件颇为感兴趣。便写下这贴,帮助更多的还不会编写README文件的同学们。README文件后缀名为md。md是markdown的缩写,markdown是一种编辑博客的语言。用惯了可视化的博客编辑器(比如优快云博客,囧),这种编程式的博客编辑方案着实让人眼前一亮。不过GitHub支持的语法在标准markdown语法的基础上做了修改,称为Github Flavored Ma

闪星的博客 1666

数学建模模型总结

这是本人在两年内准备参加数学建模竞赛搜集到的模型资料,已经经过了本人的筛选和整理,希望能够对准备参加数学建模竞赛的学弟学妹们提供一些帮助!

GitHub项目中README和README.md有什么区别?

I've noticed some GitHub projects have not only a README file, but also a README.md file. 我注意到一些Git

w36680130的博客 1819
上一篇: vscode git删除仓库
下一篇: 解决 Failed to connect to github.com port 443:connection timed out
wzg2016
博客等级 码龄10年 539粉丝 493原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值