一、標題
標題的表示一共有兩種方法:
-
使用多個#號加空格開頭一行的標題,#號數量代表標題的等級。
以此類推最多六級。一級標題
二級標題
三級標題
-
使用下一行加入===組成的下劃線的一級標題,以及下一行加入---組成的下劃線的二級標題。其中,下劃線長度沒有限制。
一級標題
一級標題
二級標題
二、格式
(一)換行
有兩種方法用于換行:
-
在末尾添加兩個空格并回車。
第一行
第二行 -
兩個回車。
第一行
第二行
(二)字體
有粗體、斜體、粗斜體三種字體樣式,其中每種樣式有兩種鍵入方法。
斜體文本
斜體文本
粗體文本
粗體文本
粗斜體文本
粗斜體文本
(三)分隔線
在單獨一行中使用三個以上的星號、減號、下劃線用于建立分隔線,符號間可以有空格,但行內不能出現其他字符。
需要特別注意使用-作為分隔線時可能與二級標題格式沖突。
正文
正文
格式沖突處
正文
正文
(四)刪除線
在文字兩端各添加兩波浪線即為刪除線。
ABCDEFGHIJK
ABCDEFGHIJK
(五)下劃線
下劃線使用<u>標簽作為起始,使用</u>標簽作為結束。
<u>標簽中間不得出現空格</u>
(六)腳注
腳注分為要標注的文本和腳注本身,將文本用中括號擴起并在中括號開頭輸入^可創建被標注的文本,腳注本身則為以上內容后添加冒號,后接說明文本。
需要注意的是[1]不支持該格式腳注
三、列表
(一)無序列表
無序列表可用星號、加號、減號加空格作為行開頭。其中,不同符號開頭的列表會被分隔開。
- 第一項
- 第二項
- 第三項
- 第四項
- 第五項
- 第六項
(二)有序列表
有序列表使用數字與.作為行開頭。其中,數字編號會自動修正。
- 第一項
- 第二項
- 第三項
- 第四項
(三)列表嵌套
在子列表行開頭添加四個空格(或tab)可實現嵌套。
- 第一大項
- 第一小項
- 第二小項
- 第一小項
- 第二大項
- 第一小項
四、區塊
在行首添加>加空格即可生成引用區塊。在區塊中可嵌套區塊。
引用區塊
嵌套
在列表中加入區塊需要在>前加入四個空格或tab。
- 列表
列表內區塊
列表外區塊
五、代碼
利用一對``可標注單行代碼。
如printf()
,該標注方法可以放于正文內。
以四個空格或tab開頭一行可生成代碼區塊。
#include<stdio.h>
void main(){
return 0;
}
或用一對```可以生成代碼區塊,并可在第一行指定語言。
x = -3:0.1:3;
y = x^2;
plot(x,y)
六、鏈接
生成鏈接的格式為
[鏈接名稱](鏈接地址)
本教程來源于菜鳥教程
鏈接地址可以放于文檔尾以節省正文文字空間。賦值格式為
[鏈接名稱][變量名稱]
[變量名稱]:鏈接地址
這個鏈接用 1 作為網址變量 Google
這個鏈接用 runoob 作為網址變量 Runoob
然后在文檔的結尾為變量賦值(網址)
七、圖片
生成圖片格式為


圖片地址可以為此.md文件的相對地址或網絡地址,也可像鏈接一樣在文檔末尾賦值。
這個鏈接用 1 作為網址變量 RUNOOB.
然后在文檔的結尾為變量賦值(網址)
若需要指定圖片的高度與寬度,需要使用<img>標簽。
<img src="http://static.runoob.com/images/runoob-logo.png" width="50%" alt="文字說明">
八、表格
使用|分隔單元格,使用-分隔表頭與元素行。
表頭 表頭 單元格 單元格 單元格 單元格
在-行加入不同符號可以設置對其方式。
-:右對齊
:-左對齊
:-:居中
左對齊列 右對齊列 居中對齊 單元格 單元格 單元格 單元格 單元格 單元格
九、高級技巧
(一)支持HTML
不在 Markdown 涵蓋范圍之內的標簽,都可以直接在文檔里面用 HTML 撰寫。
目前支持的 HTML 元素有:<kbd> <b> <i> <em> <sup> <sub> <br>等。
使用 <kbd>Ctrl</kbd>+<kbd>Alt</kbd>+<kbd>Del</kbd> 重啟電腦
請不要在閱讀本文時嘗試重啟電腦 (ー_ー)
(二)轉義
Markdown 使用了很多特殊符號來表示特定的意義,如果需要顯示特定的符號則需要使用轉義字符,Markdown 使用反斜杠轉義特殊字符。
文本加粗
** 正常顯示星號 **
Markdown 支持以下這些符號前面加上反斜杠來幫助插入普通的符號:
\ 反斜線
` 反引號
* 星號
_ 下劃線
{} 花括號
[] 方括號
() 小括號
# 井字號
+ 加號
- 減號
. 英文句點
! 感嘆號
(三)公式
當你需要在編輯器中插入數學公式時,可以使用兩個美元符 $$ 包裹 TeX 或 LaTeX 格式的數學公式來實現。提交后,問答和文章頁會根據需要加載 Mathjax 對數學公式進行渲染。
LaTeX公式可用媽咪叔提供的LaTeX公式編輯器進行生成或預覽。
(四)流程圖
可以繪制流程圖、時序圖(順序圖)、甘特圖等,但可能需要插件進行預覽。
詳情見菜鳥教程高級技巧筆記。
1、橫向流程圖源碼格式:
graph LR
A[方形] -->B(圓角)
B --> C{條件a}
C -->|a=1| D[結果1]
C -->|a=2| E[結果2]
F[橫向流程圖]
2、豎向流程圖源碼格式:
graph TD
A[方形] --> B(圓角)
B --> C{條件a}
C --> |a=1| D[結果1]
C --> |a=2| E[結果2]
F[豎向流程圖]
3、標準流程圖源碼格式:
st=>start: 開始框
op=>operation: 處理框
cond=>condition: 判斷框(是或否?)
sub1=>subroutine: 子流程
io=>inputoutput: 輸入輸出框
e=>end: 結束框
st->op->cond
cond(yes)->io->e
cond(no)->sub1(right)->op
4、標準流程圖源碼格式(橫向):
st=>start: 開始框
op=>operation: 處理框
cond=>condition: 判斷框(是或否?)
sub1=>subroutine: 子流程
io=>inputoutput: 輸入輸出框
e=>end: 結束框
st(right)->op(right)->cond
cond(yes)->io(bottom)->e
cond(no)->sub1(right)->op
5、UML時序圖源碼樣例:
對象A->對象B: 對象B你好嗎?(請求)
Note right of 對象B: 對象B的描述
Note left of 對象A: 對象A的描述(提示)
對象B-->對象A: 我很好(響應)
對象A->對象B: 你真的好嗎?
6、UML時序圖源碼復雜樣例:
Title: 標題:復雜使用
對象A->對象B: 對象B你好嗎?(請求)
Note right of 對象B: 對象B的描述
Note left of 對象A: 對象A的描述(提示)
對象B-->對象A: 我很好(響應)
對象B->小三: 你好嗎
小三-->>對象A: 對象B找我了
對象A->對象B: 你真的好嗎?
Note over 小三,對象B: 我們是朋友
participant C
Note right of C: 沒人陪我玩
7、UML標準時序圖樣例:
%% 時序圖例子,-> 直線,-->虛線,->>實線箭頭
sequenceDiagram
participant 張三
participant 李四
張三->王五: 王五你好嗎?
loop 健康檢查
王五->王五: 與疾病戰斗
end
Note right of 王五: 合理 食物 <br/>看醫生...
李四-->>張三: 很好!
王五->李四: 你怎么樣?
李四-->王五: 很好!
8、甘特圖樣例:
%% 語法示例
gantt
dateFormat YYYY-MM-DD
title 軟件開發甘特圖
section 設計
需求 :done, des1, 2014-01-06,2014-01-08
原型 :active, des2, 2014-01-09, 3d
UI設計 : des3, after des2, 5d
未來任務 : des4, after des3, 5d
section 開發
學習準備理解需求 :crit, done, 2014-01-06,24h
設計框架 :crit, done, after des2, 2d
開發 :crit, active, 3d
未來任務 :crit, 5d
耍 :2d
section 測試
功能測試 :active, a1, after des3, 3d
壓力測試 :after a1 , 20h
測試報告 : 48h
-
比如vscode平臺不支持 ?