Markdown 語法
Markdown 語法
1. 內容目錄
使用[TOC]引用目錄,例如本方目錄。
2. 標題設置
第一種:通過在文字下方添加 =和- 分別表示一級標題和二級標題
例如:“一級標題
=============”
第二種:在文字開頭加上 # 通過#的數量表示幾級標題
例如:“#一級標題 ##二級標題 ###三級標題”
3. 塊注釋
通過在文字開頭添加 > 表示塊注釋 (當>和文字之間添加五個blank時,塊注釋的文字會有變化。)
例如 > 注釋
注釋
4. 斜體
將需要設置為斜體的文字兩端使用1個 * 或者 _夾起來
例如:*斜體*
斜體
5. 粗體
將需要設置為粗體的文字兩端使用2個 * 或者 _夾起來
例如:**粗體**
粗體
6. 無序列表
在文字開頭添加(*,+,-)實現無序列表。但是要注意在(*,+,-)和文字之間需要添加空格。(建義:一個文檔中只是用一種無序列表的表示方式)
例如:+ step1
- step1
- step2
- step3
7. 有序列表
使用數字后面跟上句號點。(還要有空格)
- step1
- step2
- step3
8. 鏈接(Links)
Markdown中有兩種方式實現鏈接,分別為內聯方式和引用方式
內聯方式:使用[描述](鏈接地址) 為文字增加外鏈接
This is an example link.
引用方式:
I get 10 times more taffic from Google than from Yahoo or MSN.
9. 圖片(Images)
使用  插入圖像。
內聯方式:!\alt text
引用方式:!\alt text
10. 代碼(Code)
實現方式有兩種
第一種:簡單文字出現一個代碼框。使用`代碼`。(不是單引號而是左上角~中的
)
第二種:大片文字需要實現代碼框。使用Tab或者四個空格
這是一個代碼塊
第三種:
使用 三個` + 語言名稱進行標記。
例如:
java示例
public static void main(String[] args){
}
11. 腳注(footnote)
實現方式如下
hello1
12. 下划線
在空白行下方添加三條 - 橫線。(前面文字下方添加-,實現在2級標題)
例如:下划線
13. 標簽和分類
一般在文首輸入tags添加標簽,categories添加分類:
tags:
- Markdown
- 語言
categories
- 技術
14. 待辦事宜TODO列表
使用帶有 [ ] 或 [x] (未完成或已完成)項的列表語法撰寫一個待辦事宜列表,並且支持子列表嵌套以及混用Markdown語法。 - 空格[空格]例如:
- [ ] **Cmd Markdown 開發**
- [ ] 改進 Cmd 渲染算法,使用局部渲染技術提高渲染效率
- [ ] 支持以 PDF 格式導出文稿
- [x] 新增Todo列表功能 [語法參考](https://github.com/blog/1375-task-lists-in-gfm-issues-pulls-comments)
- [x] 改進 LaTex 功能
- [x] 修復 LaTex 公式渲染問題
- [x] 新增 LaTex 公式編號功能 [語法參考](http://docs.mathjax.org/en/latest/tex.html#tex-eq-numbers)
- [ ] **七月旅行准備**
- [ ] 准備郵輪上需要攜帶的物品
- [ ] 瀏覽日本免稅店的物品
- [x] 購買藍寶石公主號七月一日的船票
對應顯示如下待辦事宜 Todo 列表:
15. 表格
表頭1 | 表頭2 |
---|---|
Content Cell | Content Cell |
Content Cell | Content Cell |
表頭1 | 表頭2 |
---|---|
Content Cell | Content Cell |
Content Cell | Content Cell |
名字 | 描述 |
---|---|
Help | Display the help window. |
Close | Closes a window |
表格中也可以使用普通文本的刪除線,斜體等效果
名字 | 描述 |
---|---|
Help | |
Close | Closes a window |
表格可以指定對齊方式
左對齊 | 居中 | 右對齊 |
---|---|---|
col 3 is | some wordy text | $1600 |
col 2 is | centered | $12 |
zebra stripes | are neat | $1 |
16. 流程圖和時序圖
- 流程圖
語法大體分為兩段,第一段用來定義元素,第二段用來連接元素
定義元素階段的語法是
tag=>type: content:>url
tag就是一個標簽,在第二段連接元素時用
type是這個標簽的類型,從上段內容看有6中類型,非別為:
start
end
operation
subroutine
condition
inputoutput
content就是在框框中要寫的內容,中英文均可,但有一點需要特別注意,就是type后的冒號與文本之間一定要有個空格,沒空格會出問題。
url就是一個連接,與框框中的文本相綁定
連接元素階段的語法就簡單多了,直接用->來連接兩個元素,需要注意的是condition類型,因為他有yes和no兩個分支,所以要寫成
c2(yes)->io->e
c2(no)->op2->e
例如
- 時序圖
創建sequence
->中,-代表實線,>代表實心箭頭,還可以用--表示虛線,>>表示非實心箭頭。在UML時序圖中,實線表示主動發送消息,虛線表示返回(應答)消息,實心箭頭表示同步消息(消息發送者停止活動等待應答消息),非實心箭頭表示異步消息(消息發送者無須停止活動等待應答消息)。->兩邊可以是同一個Actor,表示自交互:
創建Title
title: Title
創建Actor
participant A
participant B
participant C as C_Alias
給Actor添加Note
Note right of A: I'm A
Note left of A: I'm A
Note over A: I'm A
Note over A, B: We're friends.
17. LaTeX公式
-
$表示行內公式
質能守恆方程:來表達。
-
$$表示整行公式
18. 刪除線
使用 ~~ 將要刪除文字夾起來。表示刪除線
這是一段錯誤的文本。
19. 定義型列表
- 名詞 1
- 定義 1(左側有一個可見的冒號和四個不可見的空格)
- 代碼塊 2
-
這是代碼塊的定義(左側有一個可見的冒號和四個不可見的空格)
代碼塊(左側有八個不可見的空格)
20. 分割線
分割線
可以在一行用3個以上的 *,-,_來建立一條分割線,行內除了空格不能有其他東西,當然三條線效果是不同的,按順序是很明顯,不明顯,一般。第二種不仔細看真看不到有線,我是換了暗色主題才看清。
- hi ↩