天天看點

Markdown基本文法簡介

前言:當你在git平台建立一個倉庫時,平台會自動建立一個README.md檔案,并将它的内容展現在web端頁面,方面其他讀者查閱。README.md實則是一個适用Markdown文法的文本檔案,從他的字尾md即可看出它是Markdown的縮寫。在git倉庫中README.md檔案非常的重要,它能幫助讀者快速了解倉庫代碼的功能,環境,參數,測試以及相關的注意事項,是以一個清楚易讀的md檔案非常的重要,要寫出一個清楚易讀的README.md檔案,勢必要熟悉Markdown的基本文法。

  1. md檔案編輯器

推薦visiual Studio Codes,安裝起來很友善,隻要在VS Codes中安裝一個插件即可使用,而且還有預覽功能。如下圖所示:點選左側所示功能圖示,在搜尋框搜markdown,就會跳出相關的Markdown插件,選擇“Markdown Preview”插件,點選“install”即可線上安裝,安裝完成之後重新開機下VS Codes軟體,插件就生效了。

Markdown基本文法簡介
  1. Markdown文法

2.1 标題

# 一級标題
## 二級标題
### 三級标題
#### 四級标題
##### 五級标題
###### 六級标題  <!--最多6級标題-->
           

注意,在#後面要加一個空格,否則識别不了。

2.2 清單

有序清單

1. 一級清單
   1. 二級清單
      1. 三級清單
           

1後面加點,然後加空格即可實作一級清單,如果如要多級清單,換行後連續輸入兩個空格即可,三級清單同理,同樣注意在點後面要加空格。

無序清單

- 無序清單
           

中劃線後面加個空格即可;

2.3 代碼塊

代碼放在兩行'''之間,如下圖所示:

'''
sprintf_s(buffer, "%d", i);
'''
           

如需指明是什麼語言,就在第一行的後面加上辨別符,如下,代碼塊内的内容會按照相關文法高亮顯示。

'''c++
sprintf_s(buffer, "%d", i);
'''
           

正文内部的代碼顯示方式如下,将代碼放在兩個'之間接口。

這是'sprintf_s(buffer, "%d", i);'正文内部的代碼
           

2.4 正文

正文的話直接輸入就可以了,需要注意的是換行,markdown文法中換行是要在兩行之間空一行的實作的。

小明
小剛
           

上面的内容在git倉庫的網頁端中顯示其實是屬于一行的,并沒有換行,如下的方式才能實作換行。

小明

小剛
           

2.5 加粗與傾斜

一個*之間的文字傾斜,兩個**之間的文字加粗,三個***之間的文字加粗并傾斜。

*文字傾斜*
**文字加粗**
***文字加粗并傾斜***
           

3. 預覽功能

在安裝完插件後,在VS Codes的右上角圖示,如下圖所示,點選該圖示即可。

Markdown基本文法簡介