當前位置：首頁 > 编程资源 > 编程问答 >内容正文

编程问答

CSDN-Markdown基本语法

發布時間：2023/12/15 编程问答 35 豆豆

生活随笔收集整理的這篇文章主要介紹了 CSDN-Markdown基本语法小編覺得挺不錯的,現在分享給大家,幫大家做個參考.

轉自(http://blog.csdn.net/lanxuezaipiao/article/details/44307757)

概述
- 簡單介紹Markdown
- CSDN Markdown的功能支持
標題
- Setext形式
- atx形式
區塊引用
分隔線
強調
列表
- 無序列表
- 有序列表
- 注意事項
鏈接
- 自動鏈接
- 普通文本鏈接
  - 行內式鏈接
  - 參考式鏈接
代碼
- 行內代碼
- 代碼區塊
反斜杠的用處
常見問題
參考資料

概述

簡單介紹Markdown

Markdown 是一種輕量級標記語言，它允許人們使用易讀易寫的純文本格式編寫文檔，然后轉換成格式豐富的HTML頁面。 —— 來自[維基百科]

簡單的來說，Markdown就是用“標記符號”表示“格式”。Markdown語法標簽與HTML語法標簽是一一對應的，比如Markdown的二級標題標簽##就對應著HTML中的<h2>...</h2>標記，而且Markdown是兼容HTML語法的，如果你比較喜歡 HTML 的 <a> 或 <img> 標簽，可以直接在Markdown文檔中使用這些標記，而不用 Markdown 提供的鏈接或是圖像標簽語法。

CSDN Markdown的功能支持

CSDN Markdown編輯器是使用StackEdit修改而來的，但在StackEdit的基礎上做了一些細節優化，使得體驗更加友好，CSDN Markdown支持的功能很多：

實時效果預覽并自動滾動定位到編輯處（所見即所得）
支持 Markdown Extra / GitHub Flavored Markdown 擴展語法
支持代碼語法高亮
支持 LaTeX 數學公式（基于 MathJax）
支持UML序列圖和流程圖
在線或離線管理多份 MarkDown 文檔
支持離線編輯
支持導入在線和本地Markdown文檔進行編輯
可以將編輯內容導出為 Markdown，HTML文件
管理已發布的文檔

在這篇文章，我先介紹CSDN Markdown的基本語法，我會從Markdown語法說明、例子、與其對應的HTML語法、例子效果、注意事項這幾個方面進行詳細介紹。后面會繼續介紹如何插入圖片、CSDN Markdown的擴展語法、如何寫數學公式和畫圖等相關的內容。

標題

Markdown 支持兩種形式的標題語法：Setext形式和atx形式。

Setext 形式

Markdown語法說明：

Setext 形式是采用底線的方式，利用若干個 = （最高階標題）和 - （第二階標題）完成。

例子：

這是標題1 ============= 這是標題2 -------------

對應的HTML語法：

效果：

這是標題1

這是標題2

注意事項：

這里#或-的數目是任意的，既可以寫一個也可以寫多個。

atx形式

Markdown語法說明：

atx 形式則是在行首插入 1 到 6 個 # ，分別對應到標題 1 到 6 階。

例子：

# 這是標題1 ## 這是標題2 ### 這是標題3 #### 這是標題4 ##### 這是標題5 ###### 這是標題6

轉化為HTML后分別對應<h1>...<h6>這6個標記。

效果：

這是標題1

這是標題2

這是標題3

這是標題4

這是標題5

這是標題6

注意事項：

Setext形式的標題只能表示標題1和標題2這兩階，而atx形式的標題可以表示標題1~標題6共6階。
上面#與文本之間的空格不是必需的，不加也可以，但加上是個好的習慣。
你可以選擇性地「閉合」atx樣式的標題，這純粹只是美觀用的，若是覺得這樣看起來比較舒適，你就可以在行尾加上 #，而行尾的 # 數量也不用和開頭一樣（行首的#數量決定標題的階數）。

區塊引用

Markdown語法說明：

Markdown標記區塊引用是使用 > 標記，一個段落既可以只用一個 >標記（放在段首，屬偷懶做法），也可以在一個段落的每一行前面加上 >。

例子：

> 這是一個區塊引用。與上面文本屬于一個段落，因此這一行前面可以不加`>`標記。> 由于上面空了一行，因此這是另一個不同的段落，前面的 `>`必須添加。 > 雖然這也是另一個不同的段落，但上面空行加了 `>`，因此這里段落之前的 `>`也可以省略，相當于上面空行的 `>`屬于這個段落。

對應的HTML語法：

<blockquote><p>這是一個區塊引用。與上面文本屬于一個段落，因此這一行前面可以不加`>`標記。</p><p>由于上面空了一行，因此這是另一個不同的段落，前面的 `>`必須添加。</p><p>雖然這也是另一個不同的段落，但上面空行加了 `>`，因此這里段落之前的 `>`也可以省略，相當于上面空行的 `>`屬于這個段落。</p> </blockquote>

效果：

這是一個區塊引用。
與上面文本屬于一個段落，因此這一行前面可以不加>標記。

由于上面空了一行，因此這是另一個不同的段落，前面的 >必須添加。

雖然這也是另一個不同的段落，但上面空行加了 >，因此這里段落之前的 >也可以省略，相當于上面空行的 >屬于這個段落。

注意事項：

區塊引用可以嵌套使用，即引用內的引用，只要根據層次加上不同數量的 > 即可，比如兩層就需要兩個> ：

> 這是區塊引用的第一層。 > > > 這是嵌套引用，屬于第二層，因此需要再加一個`>`，兩個`>`之間的空格不是必需的。 > > 回到區塊引用的第一層。

效果為：

這是區塊引用的第一層。

這是嵌套引用，屬于第二層，因此需要再加一個>，兩個>之間的空格不是必需的。

回到區塊引用的第一層。

引用的區塊內也可以使用其他的Markdown語法，包括標題、列表、代碼塊等：

> ## 這是一個標題。 > > 1. 這是第一個列表項。 > 2. 這是第二個列表項。 > > 這是一個代碼例子： > > printf("Hello, Minmin!\n"); return 0;

效果為：

這是一個標題。

這是第一個列表項。

這是第二個列表項。

這是一個代碼例子：

printf("Hello, Minmin!\n"); return 0;

分隔線

Markdown語法說明：

你可以在一行中用三個或以上的星號*、減號-、底線_來建立一個分隔線，行內不能有其他東西。你也可以在星號或是減號中間插入空格。下面每種寫法都可以建立一條分隔線。

例子：

* * *********- - ----------------------------------------

對應的HTML語法：

<hr />

效果：

注意事項：

從上面例子可以看出，三個以上的標記之間允許存在空格，而且這三種標記可以混用，只要三種數量加起來大于等于3即可，比如下面這樣：

**---*_***--_

強調

我們知道在HTML中起到強調作用的有兩個標簽：<em>和<strong> ，關于兩者的區別可以自行Google或看這篇文章「em和strong的區別」，Markdown中也有這兩種強調效果，使用的是星號*和底線_這兩種標記。

Markdown語法說明：

使用一個 * 或 _ 來包圍詞句，相當于用 <em> 標簽包圍（內部就是這樣轉化的）；
使用兩個 * 或 _ 包起來的話，則相當于使用 <strong>。

例子：

*使用一個星號的強調* _使用一個底線的強調_**使用兩個星號的強調** __使用兩個底線的強調__

對應的HTML語法：

<em>使用一個星號的強調</em> <em>使用一個底線的強調</em><strong>使用兩個星號的強調</strong> <strong>使用兩個底線的強調</strong>

效果：

使用一個星號的強調
使用一個底線的強調

使用兩個星號的強調
使用兩個底線的強調

注意事項：

這里的**和__兩個相同的符號中間不能留有空白，否則它們就只會被當成普通的符號。
注意<em>式的強調在不同的編輯器或瀏覽器里可能顯示效果不一樣，有的通過斜體來強調，有的通過下劃點線來強調。

列表

Markdown 支持有序列表和無序列表兩種，且列表可以嵌套使用。

無序列表

Markdown語法說明：

無序列表使用星號、加號或是減號作為列表標記，使用方法如下：

一個星號 / 一個加號 / 一個減號 + 若干個空格 + 列表項內容

例子：

* 條目1 * 條目2 * 條目3

這等同于：

+ 條目1 + 條目2 + 條目3

也等同于：

- 條目1 - 條目2 - 條目3

對應的HTML語法：

效果：

條目1
條目2
條目3

有序列表

Markdown語法說明：

有序列表則直接使用數字作為列表標記，使用方法如下：

一個數字 + 一個英文句點 + 若干個空格 + 列表項內容

例子：
1. 第1點描述
2. 第2點描述
3. 第3點描述

對應的HTML語法：

效果：

第1點描述

第2點描述

第3點描述

注意事項

（1）從有序列表所對應的HTML語法格式可以看出，你在有序列表標記上使用的數字并不會影響最終的按序輸出，即如果你的列表標記寫成：

1. 第1點描述 1. 第2點描述 1. 第3點描述

或甚至是：

4. 第1點描述 2. 第2點描述 9. 第3點描述

都會得到與上面完全相同的輸出，你可以完全不用在意數字的正確性。

（2）列表標記后面一定要接著至少一個空格或制表符，否則就是普通的文本而非列表了，即下面的寫法是列表不支持的：

*條目1 *條目2 *條目3

（3）如果列表條目間用空行分開，那么在輸出時兩個條目之間也會有一個空行，而且若有多個條目，只要其中有一個空行，輸出結果時所有條目之間都會出現空行，保持一致性。比如：

* 條目1* 條目2 * 條目3

輸出效果為：

條目1
條目2
條目3

（4）每個列表條目下都可以包含多個段落，但這些段落都必須縮進 4 個空格或 1 個制表符：

1. 這是一個有兩個段落的列表項，這是第一段。這是第二段，段首已經縮進 4 個空格或 1 個制表符，否則就處在列表之外，自成一個普通段落，下面的列表條目也將自成另一個不同的列表，序號從1開始。2. 這是列表的第二個條目。

效果為：

這是一個有兩個段落的列表條目，這是第一段。

這是第二段，段首已經縮進 4 個空格或 1 個制表符，否則就處在列表之外，自成一個普通段落，下面的列表條目也將自成另一個不同的列表，序號從1開始。

這是列表的第二個條目。

（5）如果要在列表條目內放進引用，那 > 就需要縮進：

* 含有引用的列表項，下面是引用元素： > 這是一條引用。 > 前面需要縮進4個空格或1個制表符，跟段落一樣。

效果為：

含有引用的列表條目，下面是引用元素：

這是一條引用。
前面需要縮進4 個空格或 1 個制表符，跟段落一樣。

（６）如果要在列表項內放代碼區塊的話，該區塊就需要縮進兩次，也就是8個空格或是2個制表符：

* 含有代碼塊的列表項：#include <stdio.h>int main(void) {printf("Hello, Minmin!\n");return 0;}}

效果為：

含有代碼塊的列表項：
#include <stdio.h>int main(void) {printf("Hello, Minmin!\n");return 0;} }
- 1
- 2
- 3
- 4
- 5
- 6
- 7

（7）避免產生不必要的列表項。
有時候，列表很可能會不小心產生，比如下面這樣的寫法：

1986. 這不是一個列表項。

也會產生一個下面這樣的列表：

這不是一個列表項。

換句話說，也就是在行首出現數字-句點-空白，要避免這樣的狀況，你可以在句點前面加上反斜杠，具體可以查看后面的「反斜杠的用處」一節。

1986\. 這不是一個列表項。

這樣就對了：

1986. 這不是一個列表項。

鏈接

Markdown的鏈接可分為自動鏈接和普通文本鏈接兩種類型。

自動鏈接（可點擊的URL和Email）

Markdown支持以比較簡短的自動鏈接形式來處理網址和電子郵件信箱。

Markdown語法說明：

對于本身是個URL和Email的文本來說，只要是用尖括號包起來，Markdown就會自動把它轉成鏈接。

例子：

這是一個可點擊的URL： <http://www.csdn.net/>這是一個可點擊的Email： <address@example.com>

對應的HTML語法：

對于上面普通的URL，Markdown會轉成下面的HTML語法：

而對于Email的自動鏈接也很類似，只是Markdown會先做一個編碼轉換的過程，把文字字符轉成 16 進位碼的 HTML 實體，這樣的格式可以糊弄一些不好的郵址收集機器人，例如對于上面的Email，Markdown 會轉成：

<a href="mailto:addre ss@example.co m">address@exa mple.com</a>

在瀏覽器里面，這段字串會最終轉成下面的HTML語法：
address@example.com

效果：

這是一個可點擊的URL：
http://www.csdn.net/

這是一個可點擊的Email：
address@example.com

注意事項：

對于郵件的自動鏈接，使用Markdown語法雖然可以糊弄不少的機器人，但并不能全部擋下來，不過總比什么都不做好些。不管怎樣，公開你的信箱終究會引來廣告信件的。

普通文本鏈接

Markdown支持兩種形式的普通文本鏈接語法： 行內式和參考式兩種形式。

行內式鏈接

Markdown語法說明：

下面三種語法形式都是允許的：

[鏈接文字](鏈接URL '可選的鏈接title') [鏈接文字](鏈接URL "可選的鏈接title") [鏈接文字](鏈接URL (可選的鏈接title))

詳細說明就是：

一個方括號，里面輸入鏈接文本；
接著一個圓括號，里面可以包含兩部分內容，中間用空格隔開：
- 【必須】鏈接的網址；
- 【可選】鏈接的title文字，只要用單引號、雙引號或是括弧把title文字包起來即可，加上title后，你用鼠標移到該鏈接文字時就會顯示title文字，可以把它當作一種提示信息來用，當然你也可以不用title屬性。

例子：

更多精彩的內容，可以訪問[敏敏的CSDN博客](http://blog.csdn.net/lanxuezaipiao/ "敏敏的博客")（有title屬性）。想更多的了解敏敏，可以訪問[敏敏的新浪微博](http://weibo.com/lanxuezaipiao/) （無title屬性）。

對應的HTML語法：

<p>更多精彩的內容，可以訪問 <a href="http://blog.csdn.net/lanxuezaipiao/" title="敏敏的博客">敏敏的CSDN博客</a>（有title屬性）。</p><p>想更多的了解敏敏，可以訪問<a href="http://weibo.com/lanxuezaipiao/">敏敏的新浪微博</a> （無title屬性）。</p>

* 效果：*

更多精彩的內容，可以訪問敏敏的CSDN博客（有title屬性）。

想更多的了解敏敏，可以訪問敏敏的新浪微博（無title屬性）。

注意事項：

如果你是要鏈接到同一個主機的資源，可以使用相對路徑，例如：

想要進一步了解，請訪問 [About](/about/) 頁。

參考式鏈接

Markdown語法說明：

[鏈接文字][鏈接id]

可以發現參考式的鏈接中鏈接文字的后面不是一個圓括號而是另一個方括號，在該方括號里面要填入用以辨識鏈接的標記，注意兩個方括號之間允許有空格，接著，在文檔的任意處，你可以把這個標記的鏈接內容定義出來。

鏈接內容定義的形式為：

一個方括號（前面可以選擇性地加上至多三個空格來縮進），里面輸入上面的鏈接id
接著一個冒號
接著一個以上的空格或制表符
接著鏈接的網址
選擇性地接著 title 內容，可以用單引號、雙引號或是括弧包著，與上面一樣

例子：

想知道敏敏都讀過哪些書、看過哪些電影嗎？請進入[敏敏的豆瓣][id]來了解下吧。

對應的HTML語法：

<p>想知道敏敏都讀過哪些書、看過哪些電影嗎？請進入<a href="http://blog.csdn.net/lanxuezaipiao/" title="敏敏的豆瓣">敏敏的豆瓣</a>來了解下吧。</p>

效果：

想知道敏敏都讀過哪些書、看過哪些電影嗎？請進入敏敏的豆瓣來了解下吧。

注意事項：

（1）有一個已知的問題是 Markdown.pl 1.0.1 會忽略單引號包起來的鏈接 title，因此大家在使用時盡量選擇用雙引號或括弧，避免出錯。

（2）鏈接網址也可以用尖括號包起來，如：

[id]: <http://www.douban.com/people/44971294/> "敏敏的豆瓣"

（3）你也可以把 title 屬性放到下一行，也可以加一些縮進，若網址太長的話，這樣會比較好看：

[id]: http://blog.csdn.net/lanxuezaipiao/article/details/42554035"敏敏的2014年總結"

（4）網址定義只有在產生鏈接的時候用到，并不會直接出現在文件之中，如上面的效果中沒有出現[id]:這樣的網址定義。

（5）鏈接辨別標簽可以有字母、數字、空白和標點符號，但是并不區分大小寫，因此下面兩個鏈接是一樣的：

[鏈接文本][a] [鏈接文本][A]

（6）還有一種隱式鏈接標記功能，可以讓你省略指定鏈接標記，這種情形下，鏈接標記會視為等同于鏈接文字，要用隱式鏈接標記只要在鏈接文字后面加上一個空的方括號，如果你要讓 “Google” 鏈接到 google.com，你可以簡化成：

[Google][]

然后定義鏈接內容：

[Google]: http://google.com/

（7）鏈接的定義可以放在文件中的任何一個地方，我比較偏好直接放在鏈接出現段落的后面，你也可以把它放在文件最后面，就像是注解一樣。

下面給出一個綜合性的范例，來比較下這幾種鏈接方式的差異：

采用行內式鏈接的方式：

我經常逛的網站或社區有： [CSDN](http://www.csdn.net/ "CSDN")、[知乎] (http://www.zhihu.com/ "知乎")還有[豆瓣](http://www.douban.com/ "豆瓣")。

采用參考式鏈接的方式：

我經常逛的網站或社區有： [CSDN] [1]、[知乎] [2] 還有[豆瓣] [3]。

采用鏈接名稱的方式：

我經常逛的網站或社區有： [CSDN] []、[知乎] [] 還有[豆瓣] []。

上面三種寫法產生的效果都一樣：

我經常逛的網站或社區有： CSDN、知乎還有豆瓣。

那么現在一個問題來了：這三種寫法到底該如何選用呢？哪種寫法最好？

我個人認為這是自己的喜好問題，你看哪個寫的舒服就選用哪個方法？不過從官方來看，較推薦參考式的鏈接寫法。參考式的鏈接其實重點不在于它比較好寫，而是它比較好讀，比較一下上面的范例，使用參考式的文章本身讀起來很簡潔（因為鏈接標記單獨成段了），但是用行內形式的看起來就很臃腫，還容易看錯。

使用 Markdown 的參考式鏈接，可以讓文件更像是瀏覽器最后產生的結果，讓你可以把一些標記相關的元數據移到段落文字之外，你就可以增加鏈接而不讓文章的閱讀感覺被打斷。

代碼

關于Markdown的代碼語法，下面分為行內代碼和代碼區塊兩類來說明。

行內代碼

Markdown語法說明：

如果要標記一小段行內代碼，你可以用反引號(就是跟~在一起的那個按鍵)把它包起來（`）即可：

`你要標記的行內代碼`

例子：

讓我們看看`printf()` 函數有哪些參數。

對應的HTML語法：

<p>讓我們看看<code>printf()</code> 函數有哪些參數。</p>

效果：

讓我們看看printf() 函數有哪些參數。

注意事項：

如果要在行代碼段內插入反引號，你可以用多個反引號來開啟和結束代碼段：

這是一個反引號 (`)。

就能正常輸出反引號：

這是一個反引號 (`)。
如果要在代碼段的起始處或結尾處插入一個正常的反引號，這時會有連續三個反引號連在一塊的情況，且達不到想要的效果。這時就需要在代碼段的起始和結束端各放入一個空白，起始端后面一個，結束端前面一個，例如：

這是代碼片段中的反引號：`

這樣就能產生想要的效果：

這是代碼片段中的反引號：`

代碼區塊

和程序相關的寫作通常會有已經排版好的代碼區塊，通常這些區塊我們并不希望它以一般段落文件的方式去排版（如果用一般段落的方式那么段首所有的空格都被消除了），而是照原來的樣子顯示，Markdown 會用 <pre> 和 <code> 標簽來把代碼區塊包起來。

Markdown語法說明：

要在 Markdown 中建立代碼區塊很簡單，只要簡單地縮進 4 個空格或是 1 個制表符就可以。

例子：

這是一個普通段落：這是一個代碼區塊。

對應的HTML語法：

<p>這是一個普通段落：</p><pre><code>這是一個代碼區塊。 </code></pre>

這個每行一階的縮進（4 個空格或是 1 個制表符），都會被移除，舉一個具體的代碼實例。

例子：

下面是一個簡單的Java實例：public class Test{ public static void main (String[] args){ System.out.println("歡迎訪問lanxuezaipiao！"); }

效果：

下面是一個簡單的Java實例：

public class Test{ public static void main (String[] args){ System.out.println("歡迎訪問lanxuezaipiao！"); }

注意事項：

在代碼區塊中，一般的 Markdown 語法不會被轉換，像是星號便只是星號，即用兩個星號將一句話包圍起來也不會轉化為強調，這表示你可以很容易地以 Markdown 語法撰寫 Markdown 語法相關的文件，不用擔心代碼中包含一些特殊的Markdown語法標記。

反斜杠的用處

Markdown可以利用反斜杠來插入一些在語法中有其它意義的符號，例如：如果你想要用星號加在文字旁邊的方式來做出強調效果，你可以在星號的前面加上反斜杠：

\*重點描述文本\*

效果就是：*重點描述文本*

Markdown支持以下這些符號前面加上反斜杠來幫助插入普通的符號而非Markdown語法標簽：

\ 反斜線 ` 反引號 * 星號 _ 底線 {} 花括號 [] 方括號 () 括弧 # 井號 + 加號 - 減號 . 英文句點 ! 驚嘆號

常見問題

問題1：Markdown如何添加多個空行？

我們知道Markdown的段落是由前后各一個空行形成，人為的添加多個空行會被Markdown語法自動忽略僅剩一個空行，這是比較人性化的，因為不需要人為刪除一些多余的空行了。但兩個段落之間也有需要多個空行的情況，比如上面給出一些謎題，謎底一般放在最下面，中間需要大部分的留白，這時候就需要借助HTML換行標簽來達到這個目的了（前面已經提過Markdown語法是兼容HTML的）：即在需要空行的地方插入 <br /> 標簽或 <p> 標簽。

大家如果有其它任何問題，可以在下面留言，我會將大家提問的問題都整理到這里來。

參考資料

Markdown 語法說明(簡體中文版)
在線 Markdown 編輯器 StackEdit

總結

以上是生活随笔為你收集整理的CSDN-Markdown基本语法的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。

上一篇：特斯拉 2022 年净利润翻番增长，后续
下一篇： pycharm中如何调用Anoconda

编程问答

CSDN-Markdown基本语法

目錄

概述

簡單介紹Markdown

CSDN Markdown的功能支持

標題

Setext 形式

這是標題1

這是標題2

atx形式

這是標題1

這是標題2

這是標題3

這是標題4

這是標題5

這是標題6

區塊引用

這是一個標題。

分隔線

強調

列表

無序列表

有序列表

注意事項

鏈接

自動鏈接（可點擊的URL和Email）

普通文本鏈接

行內式鏈接

參考式鏈接

代碼

行內代碼

代碼區塊

反斜杠的用處

常見問題

參考資料

總結

這是一個標題。