Markdown_01_基礎語法

概覽

原文地址:https://github.com/shirayner/java-knowledge-hierarchy/tree/master/doc/Markdowngit

本文轉自:Markdown 語法說明 (簡體中文版)github

1、區塊元素{#BlockElement}

1.段落和換行

  • 段落:一個 Markdown 段落是由一個或多個連續的文本行組成,它的先後要有一個以上的空行
  • 換行:可使用換行符<br />,同時可使用區塊應用>或區塊列表-來代替換行符以達到換行效果

2.標題

標題推薦採用類 Atx 形式:在行首插入 1 到 6 個 # ,對應到標題 1 到 6 階markdown

示例以下:app

# H1:標題一

##  H2:標題二

######  H6:標題六

效果以下:url

1553137609792

2.區塊引用

區塊引用使用>做爲標記:spa

  • 能夠只在整個段落的第一行最前面加上>
  • 區塊引用能夠嵌套
  • 區塊引用內可使用其餘markdown語法

示例以下:.net

### 2.1 在每行的最前面加上 `> `

> 在每行的最前面加上 `> `
> 在每行的最前面加上 `> `
>
> 在每行的最前面加上 `> `
> 在每行的最前面加上 `> `

### 2.2 只在整個段落的第一行最前面加上`> ` 

> 也能夠只在整個段落的第一行最前面加上 `> ` 
也能夠只在整個段落的第一行最前面加上 `> ` 
也能夠只在整個段落的第一行最前面加上 `> ` 

### 2.3 區塊引用能夠嵌套

> 區塊引用能夠嵌套
>> 區塊引用能夠嵌套
>>>> 區塊引用能夠嵌套
>
>>  區塊引用能夠嵌套
>
>  區塊引用能夠嵌套

 ### 2.4 區塊引用內可使用其餘markdown語法
 
> #### 這是一個標題:h4。
> 
> 1.   這是第一行列表項。
> 2.   這是第二行列表項。
> 
> ```java
> System.out.println("這是一個代碼塊")
> ```

效果以下:code

2.1 在每行的最前面加上 >

在每行的最前面加上 >
在每行的最前面加上 >blog

在每行的最前面加上 >
在每行的最前面加上 >

2.2 只在整個段落的第一行最前面加上>

也能夠只在整個段落的第一行最前面加上 >
也能夠只在整個段落的第一行最前面加上 >
也能夠只在整個段落的第一行最前面加上 >

2.3 區塊引用能夠嵌套

區塊引用能夠嵌套

區塊引用能夠嵌套

區塊引用能夠嵌套

區塊引用能夠嵌套

區塊引用能夠嵌套

### 2.4 區塊引用內可使用其餘markdown語法

這是一個標題:h4。

  1. 這是第一行列表項。
  2. 這是第二行列表項。
System.out.println("這是一個代碼塊")

3.列表

3.1 無序列表

無序列表可以使用以下符號做爲列表標記:

  • *
  • +
  • -

示例以下:

無序列表 `*`
*   Red
*   Green
*   Blue

無序列表 `+`
+   Red
+   Green
+   Blue

無序列表 `-`
-   Red
-   Green
-   Blue

效果以下:

無序列表 *

  • Red
  • Green
  • Blue

無序列表 +

  • Red
  • Green
  • Blue

無序列表 -

  • Red
  • Green
  • Blue

3.2 有序列表

  • 有序列表則使用 n.(n表示起始數字)

  • 從起始數字開始遞增

示例以下:

有序列表則使用數字接着一個英文句點:
1. Red
2. Green
3. Blue

列表標記上使用的數字並不會影響輸出的 HTML 結果,效果等同
1. Red
1. Green
1. Blue

如下表示起始數字爲3,
3. Red
1. Green
6. Blue

效果以下:

有序列表則使用數字接着一個英文句點:

  1. Red
  2. Green
  3. Blue

列表標記上使用的數字並不會影響輸出的 HTML 結果,效果等同

  1. Red
  2. Green
  3. Blue

效果等同

  1. Red
  2. Green
  3. Blue

3.3 列表嵌套

無序列表和有序列表均可以嵌套

示例以下:

> 無序列表

- 一級無序列表
    - 二級無序列表(一級無序列表行尾按回車,接着按Tab鍵)
    - 二級無序列表(二級無序列表行尾按回車)
    
> 有序列表(二級有序列表符號仍然是從1開始,無法寫成1.一、1.2形式)

1. 一級有序列表
     1. 二級有序列表(一級有序列表行尾按回車,接着按Tab鍵)
     2. 二級有序列表(二級有序列表行尾按回車)

效果以下

無序列表

  • 一級無序列表
    • 二級無序列表(一級無序列表行尾按回車,接着按Tab鍵)
    • 二級無序列表(二級無序列表行尾按回車)

有序列表(二級有序列表符號仍然是從1開始,無法寫成1.一、1.2形式)

  1. 一級有序列表
    1. 二級有序列表(一級有序列表行尾按回車,接着按Tab鍵)
    2. 二級有序列表(二級有序列表行尾按回車)

3.4 任務列表

任務列表中:

  • [ ] :未完成
  • [x]:完成

示例以下:

代辦事項:
- [ ] 看2小時書
- [ ] 寫一篇總結
- [ ] 聽不少首歌
- [x] 保持單身

效果以下:

代辦事項:

  • [ ] 看2小時書
  • [ ] 寫一篇總結
  • [ ] 聽不少首歌
  • [x] 保持單身

4.代碼區塊

代碼區塊使用方式以下:

​```代碼語言
多行代碼
多行代碼
​```

示例以下:

​```java
String mutiCodeBlock="這是一個代碼區塊";
System.out.println(mutiCodeBlock);
​```

效果以下:

String mutiCodeBlock="這是一個代碼區塊";
System.out.println(mutiCodeBlock);

5.表格

示例以下:

| Left-Aligned  | Center Aligned  | Right Aligned |
| :------------ |:---------------:| -----:|
| col 3 is      | some wordy text | $1600 |
| col 2 is      | centered        |   $12 |
| zebra stripes | are neat        |    $1 |

效果以下:

Left-Aligned Center Aligned Right Aligned
col 3 is some wordy text $1600
col 2 is centered $12
zebra stripes are neat $1

6.分割線

  • 在一行中用三個以上的*-_來創建一個分隔線,行內不能有其餘東西。
  • 能夠在星號或是減號中間插入空格

示例以下:

> 使用`*`
***
****
* * *

> 使用`-`
---

> 使用`_`
___

使用*


* *

> 使用-

使用_


7.目錄

填寫 `` 能夠顯示全文內容的目錄結構

示例以下:

如下是目錄:
[toc]

效果以下:

如下是目錄:

[TOC]

2、區段元素

1.連接

1.1 標準連接

標準連接有兩種語法形式:

  • 行內式:[連接文字](連接url "可選的Title")
  • 參考式:

1.1.1 行內式

行內式語法格式:

[連接文字](連接url "可選的Title")

注意連接可使用相對路徑

示例以下:

[前往百度--鼠標懸浮會顯示Title](https://www.baidu.com/ "鼠標懸浮會顯示的文本即爲Title")
[前往百度--沒有Tittle](https://www.baidu.com/)

效果以下:

前往百度--鼠標懸浮會顯示Title
前往百度--沒有Tittle

1.1.2 參考式

參考式連接的優勢在於可讀性好,通常用於學術論文上,或者某一個連接在文章中多處使用,那麼使用參考式連接能夠方便地讓你對連接進行集中管理。

參考式連接語法格式以下:

  • 標準格式

    [連接文字][連接id]
    [連接id]: 連接url "可選的Tittle"
  • 隱式連接格式:

    [連接文字][]
    [連接文字]: 連接url "可選的Tittle"
(1)標準格式

示例以下:

[前往百度][baidu]

[baidu]: https://www.baidu.com/  "鼠標懸浮會顯示的文本即爲Title"

效果以下:

前往百度

(2) 隱式連接格式

示例以下:

[前往百度][]

[前往百度]: https://www.baidu.com/  "鼠標懸浮會顯示的文本即爲Title"

效果以下:

前往百度

1.2 錨點連接

Typora 暫不支持錨點連接

錨點連接可讓你實如今當前頁面內的跳轉

語法格式以下:

# 1、區塊元素{#BlockElement}
跳轉到[1、區塊元素](#BlockElement)

效果以下:

跳轉到1、區塊元素

2.圖片

插入圖片和插入標準連接語法類似,也有行內式和參考式。

2.1 行內式

行內式語法格式:

![圖片的替代文字](圖片url "可選的Title")

示例以下:

有標題
![markDdown標題](images/1553137609792.png 「markDdown鼠標懸浮的標題哦」)

沒標題
![markDdown標題](images/1553137609792.png )

有標題
markDdown標題

沒標題
markDdown標題

2.2 參考式

參考式語法格式以下:

![圖片的替代文字][圖片id]
[圖片id]: 圖片url "可選的Tittle"

示例以下:

有標題
![markDdown標題][img_id]
[img_id]: images/1553137609792.png "可選的Tittle"

效果以下:

有標題
markDdown標題

3.代碼區段

代碼區段使用 `代碼`

示例以下:

代碼區段使用 `代碼`

效果以下:

代碼區段使用 代碼

4.斜體、粗體、下劃線、刪除線

在粗體、斜體的表示方式中,*_等效,這裏以*爲例:

  • 一個*:斜體
  • 兩個*:粗體
  • 三個*:加粗斜體

三個以上是無效的

示例以下:

*斜體*  或   _斜體_
 
**粗體** 或  __粗體__

***加粗斜體***
 
****加粗斜體****

<u>下劃線</u>

~~刪除線~~

效果以下:

斜體斜體

粗體粗體

加粗斜體

****加粗斜體****

下劃線

刪除線

5.上標、下標、腳註

5.1 上標、下標

示例以下:

上標^1^

下標~2~

效果以下:

上標^1^

下標~2~

5.2 腳註

示例以下:

百度[^1] 是一家互聯網獨角獸
[^1]:https://www.baidu.com/

效果以下:

百度1 是一家互聯網獨角獸

6.公式

具體用法參見

示例以下:

$$
\begin{align*}
y = y(x,t) &= A e^{i\theta} \\
&= A (\cos \theta + i \sin \theta) \\
&= A (\cos(kx - \omega t) + i \sin(kx - \omega t)) \\
&= A\cos(kx - \omega t) + i A\sin(kx - \omega t)  \\
&= A\cos \Big(\frac{2\pi}{\lambda}x - \frac{2\pi v}{\lambda} t \Big) + i A\sin \Big(\frac{2\pi}{\lambda}x - \frac{2\pi v}{\lambda} t \Big)  \\
&= A\cos \frac{2\pi}{\lambda} (x - v t) + i A\sin \frac{2\pi}{\lambda} (x - v t)
\end{align*}
$$

效果以下:

$$
\begin{align}
y = y(x,t) &= A e^{i\theta} \
&= A (\cos \theta + i \sin \theta) \
&= A (\cos(kx - \omega t) + i \sin(kx - \omega t)) \
&= A\cos(kx - \omega t) + i A\sin(kx - \omega t) \
&= A\cos \Big(\frac{2\pi}{\lambda}x - \frac{2\pi v}{\lambda} t \Big) + i A\sin \Big(\frac{2\pi}{\lambda}x - \frac{2\pi v}{\lambda} t \Big) \
&= A\cos \frac{2\pi}{\lambda} (x - v t) + i A\sin \frac{2\pi}{\lambda} (x - v t)
\end{align
}
$$

7.表情

可用的表情列表,請參見:Git_04_gitmoji的使用

在Markdown中可以使用表情,語法格式爲:

:表情:

示例以下:

:smile:
:zap:
:smirk:
:fire:
:bug:
:sparkles:

效果以下:

😄

😏
🔥
🐛

這些表情不只可用在Markdown中,也可用在git commit 提交信息中,具體用法參見:Git_04_gitmoji的使用

參考資料

  1. Markdown 語法說明 (簡體中文版)
  2. Markdown 語法手冊 (完整整理版)
  3. https://support.typora.io/

  1. 本身前往https://www.baidu.com/ 搜索相關資料

相關文章
相關標籤/搜索