GitHub上README語法GFM詳解

收集自互聯(lián)網(wǎng)?


README.md,md是markdown的縮寫。

Markdown是一種輕量級標(biāo)記語言,它以純文本形式(易讀易寫易更改)編寫文檔,并最終以HTML格式發(fā)布。

Markdown支持一些html標(biāo)簽,但如果完全使用html來寫的話,就喪失意義了,畢竟Markdown并非專門做前端的, 然而僅實(shí)現(xiàn)一般效果的話,它比html寫起來要簡介很多!

Markdown也可以理解為將markdown語法編寫的語言轉(zhuǎn)換成HTML內(nèi)容的工具。

不過GitHub支持的語法在標(biāo)準(zhǔn)的markdown語法的基礎(chǔ)上做出了修改,稱為 GitHub Flavored Markdown,簡稱GFW。

Markdown語法主要分為如下幾大部分:

標(biāo)題;

段落;

文本;

區(qū)塊引用;

代碼區(qū)塊;

強(qiáng)調(diào);

列表;

分割線;

鏈接;

圖片;

\反斜杠 ;

`反引號;


標(biāo)題

使用 “=”等于號?標(biāo)記一級大標(biāo)題,“=” 等于號 個數(shù)無限制,但必須大于0個;

一級大標(biāo)題

========

使用 “_”下劃線?標(biāo)記二級中標(biāo)題,“_”下劃線 個數(shù)無線,但同樣要大于0個;

二級中標(biāo)題

________

大中標(biāo)題下面都會有一條橫線,這就用于區(qū)分與一二級標(biāo)題。

一、二級大中標(biāo)題

普通標(biāo)題

# 一級標(biāo)題

## 二級標(biāo)題

### 三級標(biāo)題

#### 四級標(biāo)題

##### 五級標(biāo)題

###### 六級標(biāo)題


橫線

*** ? ?#三個星號即以上 可以顯示 虛橫線效果

--- ? ?#三個短橫線即以上 可以顯示 虛橫線效果

__ ? ?#三個下劃線即以上 可以顯示 虛橫線效果


段落

段落的前后都要有空行,所謂的空行是指沒有文字內(nèi)容。若想在段內(nèi)強(qiáng)制換行的方式是使用兩個以上空格加回車(引用中換行省略回車)。


文本

普通文本

直接輸入的文字就是普通文本。需要注意的是換行的時候不能直接通過回車來換行,需要使用 <br>(或<br/>),也就是HTML里面的標(biāo)簽。此外,要顯示一個超鏈接的話,直接輸入這個鏈接的URL就可以了,顯示出來會自動變成可鏈接的形式。

默認(rèn)的文本行首部空格都會被忽略,但如果你想用空格來排一下版的話,可以把輸入法由 半角改成全角就OK啦。

單行文本

使用兩個Tab符實(shí)現(xiàn)單行文本。

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

多行文本

只要在每行行首加上兩個Tab符就行啦!

文字超鏈接

[我的網(wǎng)址](http://www.xxx.com)

圖片

添加圖片的形式和超鏈接類似

! [alt] (URL title)

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

錨點(diǎn)

每一個標(biāo)題都是一個錨點(diǎn),和HTML的錨點(diǎn)(#)類似

[Top](#readme)


區(qū)塊引用

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

>1

>>22

>>>333

>>>>4444

嵌套效果圖


代碼區(qū)塊

我們需要在代碼的上一行和下一行用 “```”三個反引號 標(biāo)記,注意,需要和普通段落之間存在空行。

```python

from flask import Flask

print("HelloWorld!")

```

代碼區(qū)塊效果圖


強(qiáng)調(diào)(斜體、粗體、刪除線)

*斜體1*,_斜體2_ ;

**粗體1**,__粗體2__ ;

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

~~刪除線~~ ;

# 斜體,粗體,刪除線可以混合使用


列表

無序列表

使用 ?* ?標(biāo)記無序列表,星號后面有一個空格

* ul001

* ul002

* ul003

效果圖

* ul01

[tab]* ul001

[tab][tab] *ul0001

分級無序列表

有序列表

就是在數(shù)字后面加一個點(diǎn)(.),再加一個空格

1. list01

2. list02


表情

GitHub的Markdown語法支持添加emoji表情,輸入不同的符號碼(:xxx:)可以顯示不同的表情。

:blush: -----> ???

具體每一個表情的符號碼,可以查看某一博主的GitHub的emoji


diff語法

版本控制的系統(tǒng)中少不了diff的功能,即展示一個文件內(nèi)容的增加與刪除。

GFM中可以展示diff效果,綠色表示新增,紅色表示刪除。

效果圖
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容