用VsCode寫Markdown


Markdown 基本語法

段落

非常自然,一行文字就是一個段落。

比如:

這是一個段落

會被解釋成:

<p>這是一個段落。</p>

如果你需要另起一段,請在兩個段落之間隔一個空行。

這是一個段落。

這是另一個段落。

會被解釋成

<p>這是一個段落</p>

<p>這是另一個段落</p>

不隔一個空行的換行行為,在一些編輯器中被解釋為換行,即插入一個<br />標簽。
對於另外一些編輯器,會被解釋為插入一個空格。對於后者,若想要換行,在當前一行的結尾打兩個空格,在換行。就等價插入了換行標簽<br />
(vscode 就是后者,typora 普通模式是前者,源碼模式和 vscode 一樣是后者)

沒有空一行,在結尾打兩個空格的換行,還在一個段落中,在一個

標簽內。

粗體、斜體

可以使用星號*或下划線_指定粗體或者斜體。

*這是斜體*
_這也是斜體_
**這是粗體**
***這是粗體+斜體***

會被解釋成

<em>這是斜體</em>
<em>這也是斜體</em>
<strong>這是粗體</strong>
<strong><em>這是粗體+斜體</strong></em>

刪除線

一部分編輯器支持刪除線,它不是經典 markdown 中的要素。用波浪線~定義刪除線。

~~就像這樣~~

會被解釋成

<strike>就像這樣</strike>

標題

markdown 總支持 1~6 六級標題,通過在一行之前加上不同數量的井號來表示。

# 這是 H1 #

## 這是 H2 ##

### 這是 H3 ###

...

###### 這是 H6 ######

行尾可以加上任意數量的井號字符,這些字符不會算作標題內容。通常會加上相等數量的字符以保持對稱。

此外,H1 和 H2 也可以采用在文本下方添加底線來實現,比如:

這是 H1
=======

這是 H2
-------

引用

通過在行首加上大於號>來添加引用格式。

> This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.

> Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
id sem consectetuer libero luctus adipiscing.

This is a blockquote with two paragraphs. Lorem ipsum dolor sit amet,
consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus.
Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.

Donec sit amet nisl. Aliquam semper ipsum sit amet velit. Suspendisse
id sem consectetuer libero luctus adipiscing.

引用可以嵌套:

> This is the first level of quoting.
>
> > This is nested blockquote.
>
> Back to the first level.

This is the first level of quoting.

This is nested blockquote.

Back to the first level.

也可以嵌套其他格式:

> ## 這是一個標題。
>
> 1.   這是第一行列表項。
> 2.   這是第二行列表項。
>
> 給出一些例子代碼:
>
>     return shell_exec("echo $input | $markdown_script");

這是一個標題。

  1. 這是第一行列表項。
  2. 這是第二行列表項。

給出一些例子代碼:

return shell_exec("echo $input | $markdown_script");

列表

無序列表使用星號、加號或是減號作為列表標記:

*   Red
*   Green
*   Blue
  • Red
  • Green
  • Blue

等同於

+   Red
+   Green
+   Blue

-   Red
-   Green
-   Blue

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

1.  Bird
2.  McHale
3.  Parish
  1. Bird
  2. McHale
  3. Parish

內聯代碼

用反引號 ` 來標記內聯代碼,它們會解釋成 <code> 標簽。如果代碼的內容中有反引號,請用兩個反引號包裹。

代碼區域

有兩種方式標記代碼區域,原生風格是行首縮進四個空格。

這是一個普通段落:

這是一個代碼區塊。

會被解釋成

<p>這是一個普通段落:</p>

<pre><code>這是一個代碼區塊。
</code></pre>

分隔線

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

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

鏈接

[an example](http://example.com/)
[an example](http://example.com/ "Optional Title")

會被解釋為

<a href='http://example.com/'>an example</a>
<a href='http://example.com/' title="Optional Title">an example</a>

除了上面的行內式,也可以使用參考式:

[an example][id]

然后在任意空白位置定義:

[id]: http://example.com/ "Optional Title"

圖像

![Alt text](/path/to/img.jpg)
![Alt text](/path/to/img.jpg "Optional Title")

會被解釋為

<img src='/path/to/img.jpg' alt='Alt text' />
<img src='/path/to/img.jpg' alt='Alt text' title='Optional Title' />

同樣,圖像也有類似的參考式語法。

自動鏈接

如果鏈接的地址和名字重復,可以用尖括號語法將其簡化。

<http://example.com/>

就相當於

[http://example.com/](http://example.com/)

切記,大多數編輯器都會自動將符合url規則的東西視為鏈接,並且解釋成鏈接。很多時候作者由於疏忽等緣故,鏈接和后面的中文之間缺少空格,導致鏈接不正常。所以我建議,鏈接要么加上尖括號,要么兩端加上空格。

轉義

markdown支持在以下字符前面插入反斜杠

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

表格

| Item     | Value |  Qty  |
| :------- | ----: | :---: |
| Computer | $1600 |   5   |
| Phone    |   $12 |  12   |
| Pipe     |    $1 |  234  |

會被解釋成

<table>
<thead>
<tr>
  <th align="left">Item</th>
  <th align="right">Value</th>
  <th align="center">Qty</th>
</tr>
</thead>
<tbody><tr>
  <td align="left">Computer</td>
  <td align="right">$1600</td>
  <td align="center">5</td>
</tr>
<tr>
  <td align="left">Phone</td>
  <td align="right">$12</td>
  <td align="center">12</td>
</tr>
<tr>
  <td align="left">Pipe</td>
  <td align="right">$1</td>
  <td align="center">234</td>
</tr>
</tbody></table>

要注意第二行的冒號決定了居左居右還是居中,如果你不加冒號,默認是居左的。

另外可以把第一行去掉,做成沒有表頭的表格,但第二行始終是要有的。

內聯 HTML

markdown 的語法簡潔,但有其局限性,所以特意保留了內聯html這種方式。任何html標簽及其內容,都會原樣輸出到結果中。也就是說,標簽中的星號等作為markdown結構的符號,以及構成html標簽和實體的符號,都不會做任何轉義。

vscode markdown 擴展

Markdown All in One
Markdown Shortcuts

最后

本文的另外鏈接是:https://yindanny.github.io/vscode-write-markdown.html


免責聲明!

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



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