gitHub里面的README.MD编辑器的使用手册
2024-05-15 21:09:48
1，简单直接版本
这两天我一直在鼓捣git和github的使用，发现自己在gitHub里面写的READMD.md文件的样式奇丑无比，疑惑？纳闷？无解？
不可能，百度啊！
百度了一下，知识得到了一定的补充。
当然，如果你不想跟我一样去细细研究了，想直接使用就完事的话，这里我直接给拿过来了，
你用的时候，直接把这些内容在新建的README.md文件里面粘贴上，然后留下自己需要的模块修修改改就可以了。
当然，因为他不像csdn这样可以边写边预览，这里你还需要一个编辑器：
在线编辑器地址：stackedit
网址：http://mahua.jser.me/
网址：https://stackedit.io/
该内容重要参考：https://blog.csdn.net/QQ826688096/article/details/89440083
一、标题写法：
第一种方法：
1、在文本下面加上 等于号 = ，那么上方的文本就变成了大标题。等于号的个数无限制，但一定要大于0个哦。。
2、在文本下面加上 下划线 - ，那么上方的文本就变成了中标题，同样的 下划线个数无限制。
3、要想输入=号，上面有文本而不让其转化为大标题，则需要在两者之间加一个空行。
另一种方法：（推荐这种方法；注意⚠️中间需要有一个空格）
关于标题还有等级表示法，分为六个等级，显示的文本大小依次减小。不同等级之间是以井号 # 的个数来标识的。一级标题有一个 #，二级标题有两个# ，以此类推。
例如：
# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题
二、编辑基本语法
1、字体格式强调我们可以使用下面的方式给我们的文本添加强调的效果
*强调* (示例：斜体) _强调_ (示例：斜体)
**加重强调** (示例：粗体) __加重强调__ (示例：粗体)
***特别强调*** (示例：粗斜体)
___特别强调___ (示例：粗斜体)
2、代码
`<hello world>`
3、代码块高亮
```
@Override
protected void onDestroy() {EventBus.getDefault().unregister(this);super.onDestroy();
}
```
4、表格 （建议在表格前空一行，否则可能影响表格无法显示）表头 | 表头 | 表头---- | ----- | ------ 单元格内容 | 单元格内容 | 单元格内容 单元格内容 | 单元格内容 | 单元格内容 5、其他引用
图片
链接
[链接名称](https://www.baidu.com/)
6、列表
1. 项目1
2. 项目2
3. 项目3 * 项目1 （一个*号会显示为一个黑点，注意⚠️有空格，否则直接显示为*项目1） * 项目2 7、换行（建议直接在前一行后面补两个空格）
直接回车不能换行，
可以在上一行文本后面补两个空格，
这样下一行的文本就换行了。
或者就是在两行文本直接加一个空行。
也能实现换行效果，不过这个行间距有点大。 8、引用
> 第一行引用文字
> 第二行引用文字2，详细版本
你也是将下面的代码内的文件复制到README.md相关的编辑器里面就可以有预览的编辑了。
重要参考：https://blog.csdn.net/zhao_jing_bo/article/details/68063070
### 横线
-----------
***、---、___可以显示横线效果***
---
___标题
------# 一级标题
## 二级标题
### 三级标题
#### 四级标题
##### 五级标题
###### 六级标题 文本
------
### 普通文本
这是一段普通的文本
### 单行文本Hello,大家好，我是果冻虾仁。
在一行开头加入1个Tab或者4个空格。
### 文本块
#### 语法1
在连续几行的文本开头加入1个Tab或者4个空格。欢迎到访很高兴见到您祝您，早上好，中午好，下午好，晚安#### 语法2
使用一对各三个的反引号：
```
欢迎到访
我是C++码农
你可以在知乎、CSDN、简书搜索【果冻虾仁】找到我
```
该语法也可以实现代码高亮，见[代码高亮](#代码高亮)
### 文字高亮
文字高亮功能能使行内部分文字高亮，使用一对反引号。
语法：
```
`linux` `网络编程` `socket` `epoll`
```
效果：`linux` `网络编程` `socket` `epoll`也适合做一篇文章的tag
#### 换行
直接回车不能换行，
可以在上一行文本后面补两个空格，
这样下一行的文本就换行了。或者就是在两行文本直接加一个空行。也能实现换行效果，不过这个行间距有点大。
#### 斜体、粗体、删除线|语法|效果|
|----|-----|
|`*斜体1*`|*斜体1*|
|`_斜体2_`| _斜体2_|
|`**粗体1**`|**粗体1**|
|`__粗体2__`|__粗体2__|
|`这是一个 ~~删除线~~`|这是一个 ~~删除线~~|
|`***斜粗体1***`|***斜粗体1***|
|`___斜粗体2___`|___斜粗体2___|
|`***~~斜粗体删除线1~~***`|***~~斜粗体删除线1~~***|
|`~~***斜粗体删除线2***~~`|~~***斜粗体删除线2***~~|斜体、粗体、删除线可混合使用图片
------
基本格式：
```
```
alt和title即对应HTML中的alt和title属性（都可省略）：
- alt表示图片显示失败时的替换文本
- title表示鼠标悬停在图片时的显示文本（注意这里要加引号）URL即图片的url地址，如果引用本仓库中的图片，直接使用**相对路径**就可了，如果引用其他github仓库中的图片要注意格式，即：`仓库地址/raw/分支名/图片路径`，如：
```
https://github.com/guodongxiaren/ImageCache/raw/master/Logo/foryou.gif
```|#|语法|效果|
|---|---|----
|1|``|
|2|`![][foryou]`|![][foryou]注意例2的写法使用了**URL标识符**的形式，在[链接](#链接)一节有介绍。
>在文末有foryou的定义：
```
[foryou]:https://github.com/guodongxiaren/ImageCache/raw/master/Logo/foryou.gif
```链接
------
### 链接外部URL|#|语法|效果|
|---|----|-----|
|1|`[我的博客](http://blog.csdn.net/guodongxiaren "悬停显示")`|[我的博客](http://blog.csdn.net/guodongxiaren "悬停显示")|
|2|`[我的知乎][zhihu] `|[我的知乎][zhihu] |语法2由两部分组成：
- 第一部分使用两个中括号，[ ]里的标识符（本例中zhihu），可以是数字，字母等的组合，标识符上下对应就行了（**姑且称之为URL标识符**）
- 第二部分标记实际URL。>使用URL标识符能达到复用的目的，一般把全文所有的URL标识符统一放在文章末尾，这样看起来比较干净。
>>URL标识符是我起的名字，不知道是否准确。囧。。### 链接本仓库里的URL|语法|效果|
|----|-----|
|`[我的简介](/example/profile.md)`|[我的简介](/example/profile.md)|
|`[example](./example)`|[example](./example)|### 图片链接
给图片加链接的本质是混合图片显示语法和普通的链接语法。普通的链接中[ ]内部是链接要显示的文本，而图片链接[ ]里面则是要显示的图片。
直接混合两种语法当然可以，但是十分啰嗦，为此我们可以使用URL标识符的形式。|#|语法|效果|
|---|----|:---:|
|1|`[![weibo-logo]](http://weibo.com/linpiaochen)`|[![weibo-logo]](http://weibo.com/linpiaochen)|
|2|`[][zhihu]`|[][zhihu]|
|3|`[![csdn-logo]][csdn]`|[![csdn-logo]][csdn]|因为图片本身和链接本身都支持URL标识符的形式，所以图片链接也可以很简洁（见例3）。
注意，此时鼠标悬停时显示的文字是图片的title，而非链接本身的title了。
> 本文URL标识符都放置于文末### 锚点
其实呢，每一个标题都是一个锚点，和HTML的锚点（`#`）类似，比如我们 |语法|效果|
|---|---|
|`[回到顶部](#readme)`|[回到顶部](#readme)|不过要注意，标题中的英文字母都被转化为**小写字母**了。
> 以前GitHub对中文支持的不好，所以中文标题不能正确识别为锚点，但是现在已经没问题啦！## 列表
### 无序列表
#### 语法
```
* 昵称：果冻虾仁
- 别名：隔壁老王
* 英文名：Jelly
```
#### 效果
* 昵称：果冻虾仁
- 别名：隔壁老王
* 英文名：Jelly### 多级无序列表
#### 语法
```
* 编程语言* 脚本语言* Python
```
#### 效果
* 编程语言* 脚本语言* Python### 一级有序列表
#### 语法
就是在数字后面加一个点，再加一个空格。不过看起来起来可能不够明显。
```
面向对象的三个基本特征：1. 封装
2. 继承
3. 多态
```#### 效果
面向对象的三个基本特征：1. 封装
2. 继承
3. 多态### 多级有序列表
和无序列表一样，有序列表也有多级结构。
#### 语法
```
1. 这是一级的有序列表，数字1还是11. 这是二级的有序列表，阿拉伯数字在显示的时候变成了罗马数字1. 这是三级的有序列表，数字在显示的时候变成了英文字母
```#### 效果1. 这是一级的有序列表，数字1还是11. 这是二级的有序列表，阿拉伯数字在显示的时候变成了罗马数字1. 这是三级的有序列表，数字在显示的时候变成了英文字母### 复选框列表
#### 语法
```
- [x] 需求分析
- [x] 系统设计
- [x] 详细设计
- [ ] 编码
- [ ] 测试
- [ ] 交付
```
#### 效果- [x] 需求分析
- [x] 系统设计
- [x] 详细设计
- [ ] 编码
- [ ] 测试
- [ ] 交付您可以使用这个功能来标注某个项目各项任务的完成情况。
> Tip:
>> 在GitHub的**issue**中使用该语法是可以实时点击复选框来勾选或解除勾选的，而无需修改issue原文。## 块引用### 常用于引用文本
#### 文本摘自《深入理解计算机系统》P27令人吃惊的是，在哪种字节顺序是合适的这个问题上，人们表现得非常情绪化。实际上术语“little endian”（小端）和“big endian”（大端）出自Jonathan Swift的《格利佛游记》一书，其中交战的两个派别无法就应该从哪一端打开一个半熟的鸡蛋达成一致。因此，争论沦为关于社会政治的争论。只要选择了一种规则并且始终如一的坚持，其实对于哪种字节排序的选择都是任意的。
> **“端”（endian）的起源**
以下是Jonathan Swift在1726年关于大小端之争历史的描述：
“……下面我要告诉你的是，Lilliput和Blefuscu这两大强国在过去36个月里一直在苦战。战争开始是由于以下的原因：我们大家都认为，吃鸡蛋前，原始的方法是打破鸡蛋较大的一端，可是当今的皇帝的祖父小时候吃鸡蛋，一次按古法打鸡蛋时碰巧将一个手指弄破了，因此他的父亲，当时的皇帝，就下了一道敕令，命令全体臣民吃鸡蛋时打破较小的一端，违令者重罚。”### 块引用有多级结构
#### 语法
```
> 数据结构
>> 树
>>> 二叉树
>>>> 平衡二叉树
>>>>> 满二叉树
```
#### 效果
> 数据结构
>> 树
>>> 二叉树
>>>> 平衡二叉树
>>>>> 满二叉树代码高亮
----------### 语法
在三个反引号后面加上编程语言的名字，另起一行开始写代码，最后一行再加上三个反引号。### 效果
```Java
public static void main(String[]args){} //Java
```
```c
int main(int argc, char *argv[]) //C
```
```Bash
echo "hello GitHub" #Bash
```
```javascript
document.getElementById("myH1").innerHTML="Welcome to my Homepage"; //javascipt
```
```cpp
string &operator+(const string& A,const string& B) //cpp
```
表格
--------表头1 | 表头2|
--------- | --------|
表格单元 | 表格单元 |
表格单元 | 表格单元 || 表头1 | 表头2|
| ---------- | -----------|
| 表格单元 | 表格单元 |
| 表格单元 | 表格单元 |### 对齐
表格可以指定对齐方式| 左对齐 | 居中 | 右对齐 |
| :------------ |:---------------:| -----:|
| col 3 is | some wordy text | $1600 |
| col 2 is | centered | $12 |
| zebra stripes | are neat | $1 |### 混合其他语法
表格单元中的内容可以和其他大多数GFM语法配合使用，如：
#### 使用普通文本的删除线，斜体等效果| 名字 | 描述 |
| ------------- | ----------- |
| Help | ~~Display the~~ help window.|
| Close | _Closes_ a window |#### 表格中嵌入图片（链接）
其实前面介绍图片显示、图片链接的时候为了清晰就是放在在表格中显示的。| 图片 | 描述 |
| ---- | ---- |
|![baidu][baidu-logo] | 百度|表情
----------
Github的Markdown语法支持添加emoji表情，输入不同的符号码（两个冒号包围的字符）可以显示出不同的表情。比如`:blush:`，可以显示:blush:。具体每一个表情的符号码，可以查询GitHub的官方网页[http://www.emoji-cheat-sheet.com](http://www.emoji-cheat-sheet.com)。但是这个网页每次都打开**奇慢**。。所以我整理到了本repo中，大家可以直接在此查看[emoji](./emoji.md)。diff语法
---------
版本控制的系统中都少不了diff的功能，即展示一个文件内容的增加与删除。
GFM中可以显示的展示diff效果。使用绿色表示新增，红色表示删除。
#### 语法
其语法与代码高亮类似，只是在三个反引号后面写diff，
并且其内容中，以 `+ `开头表示新增，`- `开头表示删除。#### 效果```diff
+ 鸟宿池边树，僧敲月下门
- 鸟宿池边树，僧推月下门
```
也可以直接去我的gitHub参考一下我fork别的项目的案例：https://github.com/pcsAndRcx/README
gitHub里面的README.MD编辑器的使用手册相关推荐
- 42 github 开源代码 ——README.md语法/相关操作等
0 引言 最近在github上开源了pro/E二次开发的代码,发现README.md的编辑方式很有趣,需要稍微了解一下. 1 markdown语法 参考了两篇博客的内容,链接如下. https://b ...
- GitHub如何在README.md文件中插入图片
1.首先把图片放到本地文件夹中.push到Github的远程仓库. 2.在浏览器进入远程Github仓库找到图片打开图片.那么当前浏览器链接就是图片地址.复制图片的URL. 3.打开README.md ...
- 个人项目github链接及README.md
链接: https://github.com/Silvia9/Word-Count README: https://github.com/Silvia9/Word-Count/blob/mas ...
- GitHub中的readme.md
下载writage:http://www.writage.com/ writage是一个Word插件,安装这个插件后,Word的内容就可以导出成.md格式了. 在readme.md同级目录下新建'me ...
- 【GIT】GitHub中的readme.md说明文档中如何将表格居中显示？
问题描述 实际上无法将它进行视觉上的居中. 正如您在下图中看到的,GitHub 会自动呈现表格,以便它们已经占据了整个宽度.正因为如此,你不能将 GitHub 的 Markdown 渲染器生成的文本居 ...
- Hexo 博客添加 README.md 以及部署到 GitHub 丢失/显示不正常解决方法
GitHub 项目的README.md为自述文件,可对该项目进行介绍,解释等. 使用 Github Pages 和 Hexo 搭建的博客,如果在最开始建立仓库的时候没有创建README.md文件,那么 ...
- 【Git】GitHub同名项目实现丰富多彩的README.md
文章目录 导读 徽章图片 Emoji 数据统计 贪吃蛇 导读 README.md作为Markdown文件,GitHub支持了Markdown的基本语法,但不支持CSDN提供的强大的公式编辑$$功能以及 ...
- GitHub上README.md编写教程（基本语法）
今天在编写github中的readme.md文档时,发现自己写的和别人写的样式完全不一样,自己的好难看,于是百度了一番,很多都是转载的别人13年的博客,其中还发现一片17年写的原创,本以为发现了一个新 ...
- 【Github】怎么在README.md中添加图片？
原理是将图片作为文档上传,在README.md中引用即可. 参考博客:[GitHub]给GitHub上的ReadMe.md文件中添加图片怎么做 . gitHub创建文件夹
最新文章
- springcloud 组件_SpringCloud组件mica 2.0.5发布，添加对sentinel、undertow指标收集
- 微软旷视人脸识别100%失灵!照片「隐身衣」,帮你保护照片隐私数据
- python综合案例分享_Python面向对象 三大特性 综合案例+1（视频里的作业）
- 在Linux上建立日志服务器的问题
- flask和ajax,Flask flash和url_用于AJAX
- VMware Workstation卸载清理批处理命令
- 音视频技术开发周刊 | 179
- h5应用 vue 钉钉_uniapp开发一个小视频应用(一)
- 【BZOJ2730】【codevs1996】矿场建设，点双联通分量
- Python中random模块生成随机数详解
- r语言pls分析_零基础学习R语言分析GEO
- 1024程序员：算法仓鼠创业
- Google Docs API 发布，自动化文档处理
- 基础知识（四）C++常用函数.txt
- 【ZZ】ubuntu9.10桌面版使用(一)基础安装配置
- 查看 mysql端口 和进程_mysql 端口号(怎么查看mysql的端口号)
- CXF 中使用 wsdl2java 示例
- 计算机办公软件应用操作,基于计算机Word办公软件的使用及操作流程
- 利用网络月赚10000元揭密
- c语言中可以使用setw函数吗,string和stringstream+setw()用法总结