Gitee中 README.md文件的編輯和使用


最近對它的README.md文件頗為感興趣。便寫下這貼,幫助更多的還不會編寫README文件的同學們

該文件用來測試和展示書寫README的各種markdown語法。

開始編輯README

當沒有README文件的時候我們可以添加一個README.me文件

 

關於標題

規范的README文件開頭都寫上一個標題,這被稱為大標題

比大標題低一級的是中標題,也就是顯示出來比大標題小點。

大標題
===

效果如圖:

在文本下面加上 等於號 = ,那么上方的文本就變成了大標題。等於號的個數無限制,但一定要大於0個哦。。

比大標題低一級的是中標題,也就是顯示出來比大標題小點

中標題
-------

效果如圖:

在文本下面加上 下划線 - ,那么上方的文本就變成了中標題,同樣的 下划線個數無限制。

除此之外,你也會發現大,中標題下面都有一條橫線,沒錯這就是 = 和 - 的顯示結果。

如果你只輸入了等於號=,但其上方無文字,那么就只會顯示一條直線。如果上方有了文字,但你又只想顯示一條橫線,而不想把上方的文字轉義成大標題的話,那么你就要在等於號=和文字直接補一個空行。

補空行:是很常用的用法,當你不想上下兩個不同的布局方式交錯到一起的時候,就要在兩種布局之間補一個空行。

如果你只輸入了短橫線(減號)-,其上方無文字,那么要顯示直線,必須要寫三個減號以上。不過與等於號的顯示效果不同,它顯示出來時虛線而不是實線。同減號作用相同的還有星號*和下划線_,同樣的這兩者符號也要寫三個以上才能顯示一條虛橫線。

 

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

# 一級標題
## 二級標題
### 三級標題
#### 四級標題
##### 五級標題
###### 六級標題

效果如圖:

 

實際上,前文所述的大標題和中標題是分別和一級標題和二級標題對應的。即大標題大小和一級標題相同,中標題大小和二級標題相同

插入符號

圓點符

圓點符的語法在READM里* 后面要有一個空格。

* 這是一個圓點
* 這是另一個圓點
* 這還是一個圓點

效果如圖:

 此外還有二級圓點和三級圓點。就是多加一個Tab。

* 這是一個圓點
    * 這是另一個圓點
        * 這還是一個圓點

效果如圖:

 如果你覺得三級的結構還不夠表達清楚的話,我們可以試着換一種形式,請看字符包圍

縮進

縮進的含義是很容易理解的。

>數據結構  
>>樹  
>>>二叉樹  
>>>>平衡二叉樹  
>>>>>滿二叉樹  

效果如圖:

 

 當然比這個更一般的用法是這樣。常常能在書籍里面看到的效果,比如引用別人的文章。直接看效果

顯示文本

普通文本

直接輸入的文字就是普通文本。需要注意的是要換行的時候不能直接通過回車來換行,需要使用<br>(或者<br/>)。也就是html里面的標簽。事實上,markdown支持一些html標簽,你可以試試。當然如果你完全使用html來寫的話,就喪失意義了,畢竟markdown並非專門做前端的,然而僅實現一般效果的話,它會比html寫起來要簡潔得多得多啦。

這是一段普通的文本,  
直接回車不能換行,<br>  
要使用\<br>  

注意第三行的<br>前加了反斜杠 \ 。目的就是像其他語言那樣實現轉義,也就是 <  的轉義。

效果如圖:

 

 

 

此外,要顯示一個超鏈接的話,就直接輸入這個鏈接的URL就好了。顯示出來會自動變成可鏈接的形式的。

顯示空格的小Tip

默認的文本行首空格都會被忽略的,但是如果你想用空格來排一下版的話怎么辦呢,有個小技巧,那就是把你的輸入法由半角改成全角就OK啦。

單行文本

使用一個Tab符實現單行文本。

    Hello,大家好,我是果凍蝦仁。

注意前面有一個Tab。在GitHub上單行文本顯示效果如圖:

多行文本

多行文本和單行文本異曲同工,只要在每行行首加一個Tab

    歡迎到訪  
    很高興見到您  
    祝您,早上好,中午好,下午好,晚安 

 效果如圖:

 

部分文字的高亮

如果你想使一段話中部分文字高亮顯示,來起到突出強調的作用,那么可以把它用 `  ` 包圍起來。注意這不是單引號,而是Tab上方,數字1左邊的按鍵(注意使用英文輸入法)。

 

Thank `You` . Please `Call` Me `Coder`

效果如圖:

模塊高亮

開頭和結尾用```抱起來就可以實現模塊高亮,里面的內容不需要<br>就可以換行

```
hello world
美好的一天
```

效果如圖:

文本超鏈接

給一段文字加入超鏈接的格式是這樣的 [ 要顯示的文字](鏈接的地址 "懸停顯示")。比如:

[我的博客](https://www.cnblogs.com/IT-Ramon/ "糯米雪梨")

效果如圖:

懸停顯示注意這里是英文雙引號,如果不需要懸停顯示可以去除后面雙引號部分的文本。

插入圖片

網上有很多README插入圖片的教程了,經我自己多次測試呢,發現可以使用的最簡單,最基本的語法是:

//![輸入圖片說明](url "圖片標題") 
![輸入圖片說明](https://i-beta.cnblogs.com/assets/adminlogo.gif "在這里輸入圖片標題")

效果如圖:

添加圖片超鏈接

//![[輸入圖片說明](url "圖片標題")](url)
[![輸入圖片說明](https://images.gitee.com/uploads/images/2019/1210/120053_acecfbe0_4763130.gif "在這里輸入圖片標題")](https://www.cnblogs.com/)

效果和之前一樣只是點擊的時候可以跳轉到指定的地址


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM