GitHub上README语法GFM详解

收集自互联网 


README.md,md是markdown的缩写。

Markdown是一种轻量级标记语言,它以纯文本形式(易读易写易更改)编写文档,并最终以HTML格式发布。

Markdown支持一些html标签,但如果完全使用html来写的话,就丧失意义了,毕竟Markdown并非专门做前端的, 然而仅实现一般效果的话,它比html写起来要简介很多!

Markdown也可以理解为将markdown语法编写的语言转换成HTML内容的工具。

不过GitHub支持的语法在标准的markdown语法的基础上做出了修改,称为 GitHub Flavored Markdown,简称GFW。

Markdown语法主要分为如下几大部分:

标题;

段落;

文本;

区块引用;

代码区块;

强调;

列表;

分割线;

链接;

图片;

\反斜杠 ;

`反引号;


标题

使用 “=”等于号 标记一级大标题,“=” 等于号 个数无限制,但必须大于0个;

一级大标题

========

使用 “_”下划线 标记二级中标题,“_”下划线 个数无线,但同样要大于0个;

二级中标题

________

大中标题下面都会有一条横线,这就用于区分与一二级标题。

一、二级大中标题

普通标题

# 一级标题

## 二级标题

### 三级标题

#### 四级标题

##### 五级标题

###### 六级标题


横线

***    #三个星号即以上 可以显示 虚横线效果

---    #三个短横线即以上 可以显示 虚横线效果

__    #三个下划线即以上 可以显示 虚横线效果


段落

段落的前后都要有空行,所谓的空行是指没有文字内容。若想在段内强制换行的方式是使用两个以上空格加回车(引用中换行省略回车)。


文本

普通文本

直接输入的文字就是普通文本。需要注意的是换行的时候不能直接通过回车来换行,需要使用 <br>(或<br/>),也就是HTML里面的标签。此外,要显示一个超链接的话,直接输入这个链接的URL就可以了,显示出来会自动变成可链接的形式。

默认的文本行首部空格都会被忽略,但如果你想用空格来排一下版的话,可以把输入法由 半角改成全角就OK啦。

单行文本

使用两个Tab符实现单行文本。

[tab][tab]一行但行文本

多行文本

只要在每行行首加上两个Tab符就行啦!

文字超链接

[我的网址](http://www.xxx.com)

图片

添加图片的形式和超链接类似

! [alt] (URL title)

![](https://github.com/a.jpg)

锚点

每一个标题都是一个锚点,和HTML的锚点(#)类似

[Top](#readme)


区块引用

在段落的每行或某一行使用 “>”大于符号,还可以嵌套使用

>1

>>22

>>>333

>>>>4444

嵌套效果图


代码区块

我们需要在代码的上一行和下一行用 “```”三个反引号 标记,注意,需要和普通段落之间存在空行。

```python

from flask import Flask

print("HelloWorld!")

```

代码区块效果图


强调(斜体、粗体、删除线)

*斜体1*,_斜体2_ ;

**粗体1**,__粗体2__ ;

***斜粗体1***,___斜粗体2___ ;

~~删除线~~ ;

# 斜体,粗体,删除线可以混合使用


列表

无序列表

使用  *  标记无序列表,星号后面有一个空格

* ul001

* ul002

* ul003

效果图

* ul01

[tab]* ul001

[tab][tab] *ul0001

分级无序列表

有序列表

就是在数字后面加一个点(.),再加一个空格

1. list01

2. list02


表情

GitHub的Markdown语法支持添加emoji表情,输入不同的符号码(:xxx:)可以显示不同的表情。

:blush: ----->  😊

具体每一个表情的符号码,可以查看某一博主的GitHub的emoji


diff语法

版本控制的系统中少不了diff的功能,即展示一个文件内容的增加与删除。

GFM中可以展示diff效果,绿色表示新增,红色表示删除。

效果图
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,384评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,845评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,148评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,640评论 1 290
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,731评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,712评论 1 294
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,703评论 3 415
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,473评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,915评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,227评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,384评论 1 345
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,063评论 5 340
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,706评论 3 324
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,302评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,531评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,321评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,248评论 2 352

推荐阅读更多精彩内容