MarkDowm——語法篇

時間  2019-12-10
標籤 markdowm 語法 简体版
原文   原文鏈接

前言

文檔地址: http://www.markdown.cn/php

爲了本身更熟悉MarkDown的語法,作個練習吧,之後博文打算用MarkDown直接寫了。html

標題

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

類 Setext

類 Setext 形式是用底線的形式，利用 = （最高階標題）和 - （第二階標題），例如：瀏覽器

H1
=============

H2
-------------

任何數量的 = 和 - 均可以有效果。markdown

類 Atx

類 Atx 形式則是在行首插入 1 到 6 個 # ，對應到標題 1 到 6 階，例如：app

# 這是 H1 

## 這是 H2 

### 這是 H3 

#### 這是 H4 

##### 這是 H5 

###### 這是 H6

你能夠選擇性地「閉合」類 atx 樣式的標題，這純粹只是美觀用的，如果以爲這樣看起來比較溫馨，你就能夠在行尾加上 #，而行尾的 # 數量也不用和開頭同樣（行首的井字符數量決定標題的階數）：編輯器

# 這是 H1 #

## 這是 H2 ##

### 這是 H3 ### 

#### 這是 H4 ####

##### 這是 H5 ##### 

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

區塊引用

使用 >

這是一個測試的內容哦
這是一個測試的內容哦
這是一個測試的內容哦ide

> 這是一個測試的內容哦
這是一個測試的內容哦
這是一個測試的內容哦

嵌套使用

嵌套標題

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

給出例子代碼：測試

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

區塊嵌套ui

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

列表

Markdown 支持有序列表和無序列表。

無序列表

無序列表使用星號、加號或是減號做爲列表標記：

  • Red
  • Green

  • Blue
    等同於：

  • Red
  • Green

  • Blue
    也等同於：

  • Red
  • Green

  • Blue

*   Red
*   Green
*   Blue
等同於：

+   Red
+   Green
+   Blue
也等同於：

-   Red
-   Green
-   Blue

有序列表

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

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

很重要的一點是，你在列表標記上使用的數字並不會影響輸出的 HTML 結果，上面的列表所產生的 HTML 標記爲：

<ol>
<li>Bird</li>
<li>McHale</li>
<li>Parish</li>
</ol>

若是你的列表標記寫成：

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

或甚至是：

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

你都會獲得徹底相同的 HTML 輸出。重點在於，你可讓 Markdown 文件的列表數字和輸出的結果相同，或是你懶一點，你能夠徹底不用在乎數字的正確性。

若是你使用懶惰的寫法，建議第一個項目最好仍是從 1. 開始，由於 Markdown 將來可能會支持有序列表的 start 屬性。

列表項目標記一般是放在最左邊，可是其實也能夠縮進，最多 3 個空格，項目標記後面則必定要接着至少一個空格或製表符。

要讓列表看起來更漂亮，你能夠把內容用固定的縮進整理好：

  • 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.
*   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.

可是若是你懶，那也行：

  • 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.
*   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.

若是列表項目間用空行分開，在輸出 HTML 時 Markdown 就會將項目內容用

標籤包起來，舉例來講：

  • Bird
  • Magic
*   Bird
*   Magic

會被轉換爲：

<ul>
<li>Bird</li>
<li>Magic</li>
</ul>

可是這個：

  • Bird

  • Magic
*   Bird

*   Magic

會被轉換爲：

<ul>
<li><p>Bird</p></li>
<li><p>Magic</p></li>
</ul>

列表項目能夠包含多個段落，每一個項目下的段落都必須縮進 4 個空格或是 1 個製表符：

  1. This is a list item 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.

  2. Suspendisse id sem consectetuer libero luctus adipiscing.

1.  This is a list item 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.

2.  Suspendisse id sem consectetuer libero luctus adipiscing.

若是你每行都有縮進，看起來會看好不少，固然，再次地，若是你很懶惰，Markdown 也容許：

  • This is a list item with two paragraphs.

    This is the second paragraph in the list item. You're
    only required to indent the first line. Lorem ipsum dolor
    sit amet, consectetuer adipiscing elit.

  • Another item in the same list.
*   This is a list item with two paragraphs.

    This is the second paragraph in the list item. You're
only required to indent the first line. Lorem ipsum dolor
sit amet, consectetuer adipiscing elit.

*   Another item in the same list.

若是要在列表項目內放進引用，那 > 就須要縮進：

  • A list item with a blockquote:

    This is a blockquote
    inside a list item.

*   A list item with a blockquote:

    > This is a blockquote
    > inside a list item.

代碼區塊

若是要放代碼區塊的話，該區塊就須要縮進兩次，也就是 8 個空格或是 2 個製表符：

  • 一列表項包含一個列表區塊：

    <代碼寫在這>
*   一列表項包含一個列表區塊：

         <代碼寫在這>

固然，項目列表極可能會不當心產生，像是下面這樣的寫法

  1. What a great season.
1986. What a great season.

也就是在行首出現數字-句點-空白，要避免這樣的情況，你能夠在句點前面加上反斜槓。

1986\. What a great season.

代碼區塊

和程序相關的寫做或是標籤語言原始碼一般會有已經排版好的代碼區塊，一般這些區塊咱們並不但願它以通常段落文件的方式去排版,
而是照原來的樣子顯示，Markdown 會用<pre> 和 <code> 標籤來把代碼區塊包起來。

要在 Markdown 中創建代碼區塊很簡單，只要簡單地縮進 4 個空格或是 1 個製表符或是```就能夠，例如，下面的輸入：

這是一個普通段落：

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

    這是一個代碼區塊。

\```
這是一個代碼區塊。
\```

Markdown 會轉換成：

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

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

這個每行一階的縮進（4 個空格或是 1 個製表符），都會被移除，例如：

Here is an example of AppleScript:

tell application "Foo"
    beep
end tell
Here is an example of AppleScript:

    tell application "Foo"
        beep
    end tell

會被轉換爲：

<p>Here is an example of AppleScript:</p>

<pre><code>tell application "Foo"
    beep
end tell
</code></pre>

一個代碼區塊會一直持續到沒有縮進的那一行（或是文件結尾）。

HTML 實體

在代碼區塊裏面， & 、 < 和 > 會自動轉成 HTML 實體，這樣的方式讓你很是容易使用 Markdown 插入範例用的 HTML 原始碼，只須要複製貼上，再加上縮進就能夠了，剩下的 Markdown 都會幫你處理，例如：

© 2004 Foo Corporation 
<div class="footer">
  &copy; 2004 Foo Corporation
</div>

會被轉換爲：

<pre><code>&lt;div class="footer"&gt;
    &amp;copy; 2004 Foo Corporation
&lt;/div&gt;
</code></pre>

代碼區塊中，通常的 Markdown 語法不會被轉換，像是星號便只是星號，這表示你能夠很容易地以 Markdown 語法撰寫 Markdown 語法相關的文件。

分隔線

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

* * *

***

*****

- - -

---------------------------------------

連接

Markdown 支持兩種形式的連接語法： 行內式和參考式兩種形式。

不論是哪種，連接文字都是用 [方括號] 來標記。

行內式

要創建一個行內式的連接，只要在方塊括號後面緊接着圓括號並插入網址連接便可，若是你還想要加上連接的 title 文字，只要在網址後面，用雙引號把 title 文字包起來便可，例如：

This is an example inline link.

This link has no title attribute.

This is [an example](http://example.com/ "Title") inline link.

[This link](http://example.net/) has no title attribute.

會產生：

<p>This is <a href="http://example.com/" title="Title">
an example</a> inline link.</p>

<p><a href="http://example.net/">This link</a> has no
title attribute.</p>

要連接到一樣主機的資源，你可使用相對路徑：See my About page for details.

See my [About](/about/) page for details.

參考式

參考式的連接是在連接文字的括號後面再接上另外一個方括號，而在第二個方括號裏面要填入用以辨識連接的標記：

This is an example reference-style link.

This is [an example][id] reference-style link.

你也能夠選擇性地在兩個方括號中間加上一個空格：

This is [an example] id reference-style link.

This is [an example] [id] reference-style link.

接着，在文件的任意處，你能夠把這個標記的連接內容定義出來：

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

連接內容定義的形式爲：

  1. 方括號（前面能夠選擇性地加上至多三個空格來縮進），裏面輸入連接文字
  2. 接着一個冒號
  3. 接着一個以上的空格或製表符
  4. 接着連接的網址
  5. 選擇性地接着 title 內容，能夠用單引號、雙引號或是括弧包着

下面這三種連接的定義都是相同：
[foo]: http://example.com/ "Optional Title Here"
[foo]: http://example.com/ 'Optional Title Here'
[foo]: http://example.com/ (Optional Title Here)

[foo]: http://example.com/  "Optional Title Here"
[foo]: http://example.com/  'Optional Title Here'
[foo]: http://example.com/  (Optional Title Here)

請注意：有一個已知的問題是Markdown.pl 1.0.1 會忽略單引號包起來的連接 title。

連接網址也能夠用方括號包起來：

[id]: "Optional Title Here"

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

[id]: http://example.com/longish/path/to/resource/here
    "Optional Title Here"

網址定義只有在產生連接的時候用到，並不會直接出如今文件之中。

連接辨別標籤能夠有字母、數字、空白和標點符號，可是並不區分大小寫，所以下面兩個連接是同樣的：

[link text][a]
[link text][A]

隱式連接標記功能讓你能夠省略指定連接標記，這種情形下，連接標記會視爲等同於連接文字，要用隱式連接標記只要在連接文字後面加上一個空的方括號，若是你要讓 "Google" 連接到 google.com，你能夠簡化成：

Google

[Google][]

而後定義連接內容：
Google: http://google.com/

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

連接的定義能夠放在文件中的任何一個地方，我比較偏好直接放在連接出現段落的後面，你也能夠把它放在文件最後面，就像是註解同樣。

下面是一個參考式連接的範例：

I get 10 times more traffic from Google 1 than from
Yahoo 2 or MSN 3.

I get 10 times more traffic from [Google] [1] than from
[Yahoo] [2] or [MSN] [3].

  [1]: http://google.com/        "Google"
  [2]: http://search.yahoo.com/  "Yahoo Search"
  [3]: http://search.msn.com/    "MSN Search"

若是改爲用連接名稱的方式寫：

I get 10 times more traffic from Google than from
Yahoo or MSN.

I get 10 times more traffic from [Google][] than from
[Yahoo][] or [MSN][].

  [google]: http://google.com/        "Google"
  [yahoo]:  http://search.yahoo.com/  "Yahoo Search"
  [msn]:    http://search.msn.com/    "MSN Search"

上面兩種寫法都會產生下面的 HTML。

<p>I get 10 times more traffic from <a href="http://google.com/"
title="Google">Google</a> than from
<a href="http://search.yahoo.com/" title="Yahoo Search">Yahoo</a>
or <a href="http://search.msn.com/" title="MSN Search">MSN</a>.</p>

下面是用行內式寫的一樣一段內容的 Markdown 文件，提供做爲比較之用：

I get 10 times more traffic from [Google](http://google.com/ "Google")
than from [Yahoo](http://search.yahoo.com/ "Yahoo Search") or
[MSN](http://search.msn.com/ "MSN Search").

參考式的連接其實重點不在於它比較好寫，而是它比較好讀，比較一下上面的範例，使用參考式的文章自己只有 81 個字符，可是用行內形式的卻會增長到 176 個字元，若是是用純 HTML 格式來寫，會有 234 個字元，在 HTML 格式中，標籤比文本還要多。

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

強調

Markdown 使用星號（*）和底線（_）做爲標記強調字詞的符號，被 * 或 _ 包圍的字詞會被轉成用 <em> 標籤包圍，用兩個 * 或 _ 包起來的話，則會被轉成<strong>，例如：

single asterisks

single underscores

double asterisks

double underscores

*single asterisks*

_single underscores_

**double asterisks**

__double underscores__

會轉成：

<em>single asterisks</em>

<em>single underscores</em>

<strong>double asterisks</strong>

<strong>double underscores</strong>

你能夠隨便用你喜歡的樣式，惟一的限制是，你用什麼符號開啓標籤，就要用什麼符號結束。

強調也能夠直接插在文字中間：

unfriggingbelievable

un**frigging**believable

若是你的 * 和 _ 兩邊都有空白的話，它們就只會被當成普通的符號。

若是要在文字先後直接插入普通的星號或底線，你能夠用反斜線：

*this text is surrounded by literal asterisks*

\*this text is surrounded by literal asterisks\*

代碼

若是要標記一小段行內代碼，你能夠用反引號把它包起來（`），例如：

Use the printf() function.

Use the `printf()` function.

會產生：

<p>Use the <code>printf()</code> function.</p>

若是要在代碼區段內插入反引號，你能夠用多個反引號來開啓和結束代碼區段：

There is a literal backtick (`) here.

\``There is a literal backtick (`) here.\``

這段語法會產生：

<p><code>There is a literal backtick (`) here.</code></p>

代碼區段的起始和結束端均可以放入一個空白，起始端後面一個，結束端前面一個，這樣你就能夠在區段的一開始就插入反引號：

A single backtick in a code span: `

A backtick-delimited string in a code span: `foo`

A single backtick in a code span: `` ` ``

A backtick-delimited string in a code span: `` `foo` ``

會產生：

<p>A single backtick in a code span: <code>`</code></p>

<p>A backtick-delimited string in a code span: <code>`foo`</code></p>

在代碼區段內，& 和方括號都會被自動地轉成 HTML 實體，這使得插入 HTML 原始碼變得很容易，Markdown 會把下面這段：

Please don't use any <blink> tags.

Please don't use any `<blink>` tags.

轉爲：

<p>Please don't use any <code><blink></code> tags.</p>

你也能夠這樣寫：

&#8212; is the decimal-encoded equivalent of &mdash;.

`&#8212;` is the decimal-encoded equivalent of `&mdash;`.

以產生：

<p><code>&amp;#8212;</code> is the decimal-encoded
equivalent of <code>&amp;mdash;</code>.</p>

圖片

很明顯地，要在純文字應用中設計一個「天然」的語法來插入圖片是有必定難度的。

Markdown 使用一種和連接很類似的語法來標記圖片，一樣也容許兩種樣式： 行內式和參考式。

行內式

行內式的圖片語法看起來像是：

Alt text

Alt text

![Alt text](https://k.zol-img.com.cn/sjbbs/7692/a7691405_s.jpg)

![Alt text](https://k.zol-img.com.cn/sjbbs/7692/a7691405_s.jpg "Optional title")

詳細敘述以下：

一個驚歎號 !
接着一個方括號，裏面放上圖片的替代文字
接着一個普通括號，裏面放上圖片的網址，最後還能夠用引號包住並加上 選擇性的 'title' 文字。

參考式

參考式的圖片語法則長得像這樣：

hhhhhhhh

![Alt text][id]
[id]: https://k.zol-img.com.cn/sjbbs/7692/a7691405_s.jpg  "Optional title attribute"

「id」是圖片參考的名稱，圖片參考的定義方式則和連結參考同樣

到目前爲止， Markdown 尚未辦法指定圖片的寬高，若是你須要的話，你可使用普通的 標籤。

表格

字段 字段 字段
1 4 123
2 4 123
3 4 123 
| 字段 | 字段| 字段|
| --- |-----| -----|
| 1 | 4 | 123 |
| 2 | 4 | 123 |
| 3 | 4 | 123 |

公式

藉助在線 LaTeX 公式編輯器

在線 LaTeX 公式編輯器

藉助MathJax引擎(嘗試沒成功)
文檔 | https://math.meta.stackexchange.com/questions/5020/mathjax-basic-tutorial-and-quick-reference

其它

反斜槓

Markdown 能夠利用反斜槓來插入一些在語法中有其它意義的符號，例如：若是你想要用星號加在文字旁邊的方式來作出強調效果（但不用 <em> 標籤），你能夠在星號的前面加上反斜槓：

*literal asterisks*

\*literal asterisks\*

Markdown 支持如下這些符號前面加上反斜槓來幫助插入普通的符號：

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

自動連接

Markdown 支持以比較簡短的自動連接形式來處理網址和電子郵件信箱，只要是用方括號包起來， Markdown 就會自動把它轉成連接。通常網址的連接文字就和連接地址同樣，例如：

http://example.com/

<http://example.com/>

Markdown 會轉爲：

<a href="http://example.com/">http://example.com/</a>

郵址的自動連接也很相似，只是 Markdown 會先作一個編碼轉換的過程，把文字字符轉成 16 進位碼的 HTML 實體，這樣的格式能夠糊弄一些很差的郵址收集機器人，例如：

<address@example.com>

Markdown 會轉成：

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

在瀏覽器裏面，這段字串（實際上是<a href="mailto:address@example.com">address@example.com</a>）會變成一個能夠點擊的「address@example.com」連接。

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程