一、文本
樣式 |
語法 |
備註 |
標題 |
N個# + 空格 + 標題 |
標題最多6級, |
高亮 |
*號包裹加粗或傾斜 |
*斜體,**粗體,***粗斜體 |
引用 |
可用>前綴表示引用 |
其中N沒有限制 |
上下角標 |
角標用sup,sub標籤 |
X2, logN |
超鏈接 |
[鏈接名](鏈接地址 '鏈接title') |
去底部 |
代碼 |
`包裹單行代碼,```包裹代碼塊 |
```獨佔一行,可帶開發語言 |
公式 |
居左$ x=y^2 $ , 居中$$ x=y^2 $$ |
x=2a−b±b2−4ac. |
二、表格
列表 |
語法 |
無序列表 |
*, -, + 任一種 + 空格 + 內容 |
有序列表 |
數字 + 空格 + 內容 |
列表嵌套 |
下一級比上一級縮進3個空格 |
三、圖文混合
引用圖片: ![圖片alt](圖片地址 '圖片title')
流程圖
- 定義參數:
標籤名=>標籤類型: 標籤描述
- 連接參數:
標籤A->標籤2(yes|no, top|right|down|left)
標籤類型 |
含義 |
start |
流程開始 |
end |
流程結束 |
operation |
處理 |
subroutine |
子程序 |
condition |
條件,連接時可以加yes或no |
inputoutput |
輸出 |
時序圖
- 實體通信:
實體A->實體B: 通信描述
通信描述可省略,但:不可以省略
- 註釋描述:
Note left|right of 實體X: 註釋文本
代表註釋在實體X的旁邊
通信符號 |
含義 |
- |
實線:主動請求 |
– |
虛線:請求返回 |
> |
實心箭頭:同步消息 |
>> |
空心箭頭:異步消息 |