MarkDown入門指南


markdown 入門簡明指南

覺得有用的話,歡迎一起討論相互學習~


我的微博我的github我的B站

標題

標題是每篇文章必備而且最常用的格式。

在Markdown中,如果想將一段文字定義為標題,只需要在這段文字前面加上 #,再在 # 后加一個空格即可。還可增加二、三、四、五、六級標題,總共六級,只需要增加 # ,增加一個 # ,標題字號相應降低一級。如下:

一號標題

二號標題

三號標題

四號標題

五號標題
六號標題

空行

對於空行,需要在編輯模式下空整整一行,才能被認定為是空行,但是對於空一行和空兩行在預覽模式下沒有任何的區別。

換行

對於編輯模式中即使使用回車鍵換行,實際顯示的是一個小空格編輯模式中由於單行位置不夠導致的換行,在實際顯示中會由於顯示頁面的大小自行更改。
正式的換行應該為在兩個空格后使用換行符(Enter鍵)

強調

markdown中使用兩個連等號括起來的部分表示強調其中的內容強調

==強調==

編輯器

對於編輯器我覺得最好的編輯器是Atom,這個編輯器是Github公司開發的並且支持開源,而且有相當多的插件,支持代碼表格,代碼向下滾動,導出為PDF格式,插入圖片,插入代碼自動提醒等功能。更主要的是在國外有大量的用戶,並且能夠對其進行及時維護。

列表

  • 無序列表

列表格式也很常用,它可以讓你的文稿變得井井有條。在Markdown 中,你只需要在文字前面加上-就可以了;如果你希望是有序列表,在文字前面加上 1. 2. 3. 即可。
注意-和1.與文字之間要保留一個字符的空格

  • 列表1

    • 列表1.1 (在一行的開頭Tab- 列表1.1)
      • 列表1.1.1(轉到下一行后緊接着上一行開頭使用Tab- 列表1.1.1即可)
        • 列表1.1.1.1(同上,是一種遞歸的過程)
          • 列表1.1.1.1.1(同上,是一種遞歸的過程)
  • 列表2

  • 列表3

  • 有序列表

  • 對於列表和標題也可以相互嵌套使用,具體是先使用列表樣式在使用標題樣式

  1. 列表1

    1. 列表1.1 注意只能使用1.或者2.類似標注,1.1這樣標注不支持
    2. 列表1.2 注意1.和2.的效果相同,形式相同即可,與具體數字符號無關
    3. 列表1.3
      1. 列表1.3.1
      2. 列表1.3.2
        1. 列表1.3.2.1第四級
  2. 列表2

引用

如果你需要在文稿中引用一段別處的句子,那么就要用到「引用」格式。

在引用文字前加上 > 並與文字保留一個字符的空格,即可。

Github about Me https://github.com/Asurada2015

粗體和斜體

Markdown 的粗體和斜體也非常簡單:

用兩個 * 包含一段文本就是粗體的語法;

用一個 * 包含一段文本就是斜體的語法。
斜體

斜體

粗體

粗體

代碼為
*斜體*  
## *斜體*  
**粗體**  
## **粗體**  

對於斜體和粗體都可以進行嵌套使用,並且符號與文本之間無需空格

代碼

代碼使用三個頓號包括的代碼塊包圍起來
例如:

這是代碼
```
這是代碼
```

數學公式

例如:

E = mc^2
```math
E = mc^2
```

中划線

中划線

代碼為
~~中划線~~

下划線

++下划線++

++下划線++

水平分界線


---

鏈接與圖片

鏈接

在 Markdown 中,插入鏈接只需要使用 [顯示文本](鏈接地址) 即可。

圖片

在 Markdown 中,插入圖片只需要使用 ![顯示文本](圖片鏈接地址) 即可。

注意:

插入圖片和鏈接的語法很像,只是前面多了一個 !感嘆號

插入圖片

![圖片名稱](圖片地址)

分割線

分割線的語法只需要另起一行,連續輸入三個星號 *** 即可分割兩段文字內容。

***
或者
---

表格

當你需要在Markdown中鍵入表格
插入表格
參考
image

待辦與清單

待辦事項和清單在日常工作、生活中經常被使用。

在Markdown中,你只需要在待辦的事項文本或者清單文本前加上- [ ]、- [x]即可。

- [ ] 表示未完成,- [x] 表示已完成。

注:鍵入字符與字符之間都要保留一個字符的空格

To-do List

-[x] 已完成項目1
    -[x] 已完成事項1
    -[x] 已完成事項2
-[ ] 待辦事項1
-[ ] 待辦事項2
- [x] 已完成項目1
- [x] 已完成事項1
- [x] 已完成事項2
- [ ] 待辦事項1
- [ ] 待辦事項2
-[x] 已完成項目1
    -[x] 已完成事項1
    -[x] 已完成事項2
-[ ] 待辦事項1
-[ ] 待辦事項2
  • [x] 已完成項目1
    • [x] 已完成事項1
    • [x] 已完成事項2
  • [ ] 待辦事項1
  • [ ] 待辦事項2

流程圖

在Markdown中,一段流程圖語法以三個上撇號開頭,以三個上撇號結尾。

在三個上撇號后另起一行,書寫graphXX,用以確定將要繪制的流程圖及其類型(XX表示流程圖類型)。

流程圖分為豎向和橫向兩大類,豎向包括自上而下和自下而上兩種順序,橫向包括從右到左和從左到右兩種順序。

其對應語法分別為:graph TB/graph BT/graph RL/graph LR。

TB - top bottom(自上而下)
BT - bottom top(自下而上)
RL - right left(從右到左)
LR - left right(從左到右)

簡單示例

自上而下

graph TB
A-->B
```
graph TB
A-->B
```

自下而上

graph BT
A-->B
```
graph BT
A-->B
```

自左向右

graph LR
A-->B
```
graph LR
A-->B
```

自右向左

graph RL
A-->B
```
graph RL
A-->B
```

具體示例

流程圖

graph TD
    A[Christmas方括號]-->B(Go shopping圓括號)
    B-->|選擇括號|C{Let me think}
    C---|直線| D[Laptop]
    C-->|箭頭| E[iPhone]
    C-->|標簽三| F[Car]
```
 graph TD
    A[Christmas方括號]-->B(Go shopping圓括號)
    B-->|選擇括號|C{Let me think}
    C---|直線| D[Laptop]
    C-->|箭頭| E[iPhone]
    C-->|標簽三| F[Car]
```

For More

更多流程圖語法

甘特圖

注意這里的冒號,逗號都要使用英文的符號的形式

gantt
dateFormat YYYY-MM-DD
title 產品計划表
section 初期階段
明確需求:2016-03-01, 10d
section 中期階段
跟進階段:2016-03-11, 18d
section 后期階段
走查階段:2016-03-20, 23d
 ```
gantt
dateFormat YYYY-MM-DD
title 產品計划表
section 初期階段
明確需求:2016-03-01, 10d
section 中期階段
跟進階段:2016-03-11, 18d
section 后期階段
走查階段:2016-03-20, 23d
```

For More

更多甘特圖語法

數據流圖例子

graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;
    graph TD;
    A-->B;
    A-->C;
    B-->D;
    C-->D;

流程圖例子

sequenceDiagram
    participant Alice
    participant Bob
    Alice->John: Hello John, how are you?
    loop Healthcheck
        John->John: Fight against hypochondria
    end
    Note right of John: Rational thoughts <br/>prevail...
    John-->Alice: Great!
    John->Bob: How about you?
    Bob-->John: Jolly good!
```
sequenceDiagram
participant Alice
participant Bob
Alice->John: Hello John, how are you?
loop Healthcheck
    John->John: Fight against hypochondria
end
Note right of John: Rational thoughts <br/>prevail...
John-->Alice: Great!
John->Bob: How about you?
Bob-->John: Jolly good!
```

甘特圖例子

        dateFormat  YYYY-MM-DD
        title Adding GANTT diagram functionality to mermaid
        section A section
        Completed task            :done,    des1, 2014-01-06,2014-01-08
        Active task               :active,  des2, 2014-01-09, 3d
        Future task               :         des3, after des2, 5d
        Future task2               :         des4, after des3, 5d
        section Critical tasks
        Completed task in the critical line :crit, done, 2014-01-06,24h
        Implement parser and jison          :crit, done, after des1, 2d
        Create tests for parser             :crit, active, 3d
        Future task in critical line        :crit, 5d
        Create tests for renderer           :2d
        Add to mermaid                      :1d

    gantt
        dateFormat  YYYY-MM-DD
        title Adding GANTT diagram functionality to mermaid
        section A section
        Completed task            :done,    des1, 2014-01-06,2014-01-08
        Active task               :active,  des2, 2014-01-09, 3d
        Future task               :         des3, after des2, 5d
        Future task2               :         des4, after des3, 5d
        section Critical tasks
        Completed task in the critical line :crit, done, 2014-01-06,24h
        Implement parser and jison          :crit, done, after des1, 2d
        Create tests for parser             :crit, active, 3d
        Future task in critical line        :crit, 5d
        Create tests for renderer           :2d
        Add to mermaid                      :1d

參考資料

有道雲筆記Markdown教程


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM