1. 程式人生 > >前端寫README.MD的最全Markdown使用幫助

前端寫README.MD的最全Markdown使用幫助

   # 最全Markdown使用幫助
   ---------------------------
   撤銷:Ctrl/Command + Z
   重做:Ctrl/Command + Y
   加粗:Ctrl/Command + B
   斜體:Ctrl/Command + I
   標題:Ctrl/Command + Shift + H
   無序列表:Ctrl/Command + Shift + U
   有序列表:Ctrl/Command + Shift + O
   檢查列表:Ctrl/Command + Shift + C
   插入程式碼:Ctrl/Command + Shift + K
   插入連結:Ctrl/Command + Shift + L
   插入圖片:Ctrl/Command + Shift + G
   標題
   ---------------------------
   # 1級標題
   ## 2級標題
   ### 3級標題
   #### 四級標題 
   ##### 五級標題 
   ###### 陸級標題
   文字樣式
   ---------------------------
   *強調文字* _強調文字_
   **加粗文字** __加粗文字__
   ==標記文字==
   ~~刪除文字~~
   > 引用文字
   H~2~O is是液體。
   2^10^ 運算結果是 1024。
   列表
   ---------------------------
   - 專案
   * 專案
   + 專案
   1. 專案1
   2. 專案2
   3. 專案3
   - [ ] 計劃任務
   - [x] 完成任務
   連結
   ---------------------------
   連結: [link](https://mp.csdn.net).
   圖片: ![Alt](https://avatar.csdn.net/7/7/B/1_ralf_hx163com.jpg)
   帶尺寸的圖片: ![Alt](https://avatar.csdn.net/7/7/B/1_ralf_hx163com.jpg =30x30) 程式碼片
   ---------------------------
   下面展示一些 `內聯程式碼片`。
   ```
   // A code block
   var foo = 'bar';
   ```
   ```javascript
   // An highlighted block
   var foo = 'bar';
   ```
   1. 程式碼片必須手動宣告程式碼語言型別
   2. 目前支援程式碼型別: `markup`、`html`、`svg`、`xml`、`c`、`clike`、`cpp`、`csharp`、`java`、`vbnet`、`go`、`ruby/rb`、`python/py`、`php`、`sql`、`perl`、`objectivec`、`swift`、`javascript/js`、`css`、`handlebars`、`bash`、`kotlin`
   3. 程式碼片主題
   預設主題為:Atom One Dark 
   可以前往 [**寫作中心/部落格設定**](https://mp.csdn.net/configure) 在**程式碼片樣式**項進行更改
   表格
   ---------------------------
   專案 | Value
   -------- | -----
   電腦 | $1600
   手機 | $12
   導管 | $1
   | Column 1 | Column 2 |
   |:--------:| -------------:|
   | centered 文字居中 | right-aligned 文字居右 |
   自定義列表
   ---------------------------
   Markdown
   : Text-to-HTML conversion tool
   Authors
   : John
   : Luke
   註腳
   ---------------------------
   一個具有註腳的文字。[^1]
   [^1]: 註腳的解釋
   註釋
   ---------------------------
   Markdown將文字轉換為 HTML。
   *[HTML]: 超文字標記語言
   KaTex 數學公式
   ---------------------------
   Gamma公式展示 $\Gamma(n) = (n-1)!\quad\forall
   n\in\mathbb N$ 是通過 Euler integral
   $$
   \Gamma(z) = \int_0^\infty t^{z-1}e^{-t}dt\,.
   $$
   新的數學公式使用了KaTex,其語法與 LaTex基本一致,但也有一些不同的地方,具體請參考KaTex官方使用文件: [https://katex.org/docs/supported.html](https://katex.org/docs/supported.html)
   插入甘特圖
   ---------------------------
   ```mermaid
   gantt
   dateFormat YYYY-MM-DD
   title Adding GANTT diagram functionality to mermaid
   section 現有任務
   已完成 :done, des1, 2014-01-06,2014-01-08
   進行中 :active, des2, 2014-01-09, 3d
   計劃中 : des3, after des2, 5d
   ```
   插入UML圖
   ------------
   ```mermaid
   sequenceDiagram
   張三 ->> 李四: 你好!李四, 最近怎麼樣?
   李四-->>王五: 你最近怎麼樣,王五?
   李四--x 張三: 我很好,謝謝!
   李四-x 王五: 我很好,謝謝!
   Note right of 王五: 李四想了很長時間, 文字太長了
   不適合放在一行.
   李四-->>張三: 打量著王五...
   張三->>王五: 很好... 王五, 你怎麼樣?
   ```
   插入Mermaid流程圖
   --------
   ```mermaid
   graph LR
   A[長方形] -- 連結 --> B((圓))
   A --> C(圓角長方形)
   B --> D{菱形}
   C --> D
   ```
   插入Flowchart流程圖
   -------
   ```mermaid
   flowchat
   st=>start: 開始
   e=>end: 結束
   op=>operation: 我的操作
   cond=>condition: 確認?
   st->op->cond
   cond(yes)->e
   cond(no)->op
   ```

最全Markdown使用幫助


撤銷:Ctrl/Command + Z
重做:Ctrl/Command + Y
加粗:Ctrl/Command + B
斜體:Ctrl/Command + I
標題:Ctrl/Command + Shift + H
無序列表:Ctrl/Command + Shift + U
有序列表:Ctrl/Command + Shift + O
檢查列表:Ctrl/Command + Shift + C
插入程式碼:Ctrl/Command + Shift + K
插入連結:Ctrl/Command + Shift + L
插入圖片:Ctrl/Command + Shift + G
標題

1級標題

2級標題

3級標題

四級標題

五級標題
陸級標題

文字樣式

強調文字 強調文字
加粗文字 加粗文字
標記文字
刪除文字

引用文字
H2O is是液體。
210 運算結果是 1024。
列表


  • 專案
  • 專案
  • 專案
  1. 專案1
  2. 專案2
  3. 專案3
  • 計劃任務
  • 完成任務
    連結

連結: link.
圖片: Alt
帶尺寸的圖片: Alt 程式碼片

下面展示一些 內聯程式碼片

// A code block
var foo = 'bar';
// An highlighted block
var foo = 'bar';
  1. 程式碼片必須手動宣告程式碼語言型別
  2. 目前支援程式碼型別: markuphtmlsvgxmlcclikecppcsharpjavavbnetgoruby/rbpython/pyphpsqlperlobjectivecswiftjavascript/jscsshandlebarsbashkotlin
  3. 程式碼片主題
    預設主題為:Atom One Dark
    可以前往 寫作中心/部落格設定程式碼片樣式項進行更改
    表格

專案 Value
電腦 $1600
手機 $12
導管 $1
Column 1 Column 2
:--------: -------------:
centered 文字居中 right-aligned 文字居右

自定義列表

Markdown
: Text-to-HTML conversion tool
Authors
: John
: Luke
註腳

一個具有註腳的文字。1


Markdown將文字轉換為 HTML

KaTex 數學公式

Gamma公式展示 Γ ( n ) = ( n 1 ) ! n N \Gamma(n) = (n-1)!\quad\forall n\in\mathbb N 是通過 Euler integral
Γ ( z ) = 0 t z 1 e t d t   . \Gamma(z) = \int_0^\infty t^{z-1}e^{-t}dt\,.
新的數學公式使用了KaTex,其語法與 LaTex基本一致,但也有一些不同的地方,具體請參考KaTex官方使用文件: https://katex.org/docs/supported.html
插入甘特圖

插入UML圖

sequenceDiagram
張三 ->> 李四: 你好!李四, 最近怎麼樣?
李四-->>王五: 你最近怎麼樣,王五?
李四--x 張三: 我很好,謝謝!
李四-x 王五: 我很好,謝謝!
Note right of 王五: 李四想了很長時間, 文字太長了
不適合放在一行.
李四-->>張三: 打量著王五...
張三->>王五: 很好... 王五, 你怎麼樣?

插入Mermaid流程圖

插入Flowchart流程圖


  1. 註腳的解釋
    註釋 ↩︎