1. 程式人生 > >GitHub ReadME.md

GitHub ReadME.md

直接 png 強調 空格 示例 www aid ref 字體

GitHub ReadME.md

GitHub ReadME.md Grammar

最近提交GitHub時發現有些人的ReadME.md寫的非常漂亮,很好奇他們是怎麽做到的,於是就搜了一下,原來ReadME.md不僅僅是隨便寫寫的,它是由其特殊的語法的叫Markdown,剛好hexo寫文章用的也是Markdown,所以這裏列出一些基本的語法,以便於以後寫ReadME.md時參考。

二、編輯基本語法 (註意??中間需要有一個空格 )

1、字體格式強調

我們可以使用下面的方式給我們的文本添加強調的效果

1
2
3
4
5
6
*強調*  (示例:斜體)  
_強調_ (示例:斜體)

**加重強調** (示例:粗體)
__加重強調__ (示例:粗體)
***特別強調*** (示例:粗斜體)
___特別強調___ (示例:粗斜體)

標題等級

關於標題還有等級表示法,分為六個等級,顯示的文本大小依次減小。不同等級之間是以井號 # 的個數來標識的。一級標題有一個 #,二級標題有兩個# ,以此類推。例如:

1
2
3
4
5
6
# 一級標題  
## 二級標題
### 三級標題
#### 四級標題
##### 五級標題
###### 六級標題

2、代碼

1
`<hello world>`

3、代碼塊高亮

三個反引號標簽

4、表格 (建議在表格前空一行,否則可能影響表格無法顯示)

1
2
3
4
表頭  | 表頭  | 表頭
---- | ----- | ------
單元格內容 | 單元格內容 | 單元格內容
單元格內容 | 單元格內容 | 單元格內容

5、其他引用

圖片
1
2
3
![圖片名稱](https://www.baidu.com/img/bd_logo1.png)
鏈接
[鏈接名稱](https://www.baidu.com/)

6、列表

1
2
3
4
5
1. 項目1  
2. 項目2
3. 項目3
* 項目1 (一個*號會顯示為一個黑點,註意??有空格,否則直接顯示為*項目1)

* 項目2

7、換行(建議直接在前一行後面補兩個空格)

直接回車不能換行,  
可以在上一行文本後面補兩個空格,  
這樣下一行的文本就換行了。
或者就是在兩行文本直接加一個空行。
也能實現換行效果,不過這個行間距有點大。  

8、引用

1
2
> 第一行引用文字  
> 第二行引用文字
Share

GitHub ReadME.md