Skip to content

Instantly share code, notes, and snippets.

Show Gist options
  • Select an option

  • Save FantasyQ/a16f2c283c092b533053f50f63b8fe4a to your computer and use it in GitHub Desktop.

Select an option

Save FantasyQ/a16f2c283c092b533053f50f63b8fe4a to your computer and use it in GitHub Desktop.

Revisions

  1. @billy3321 billy3321 revised this gist Jun 14, 2016. 1 changed file with 25 additions and 22 deletions.
    47 changes: 25 additions & 22 deletions Markdown Cheatsheet 中文版.md
    Original file line number Diff line number Diff line change
    @@ -1,9 +1,12 @@

    這篇文章旨在作為快速參考與展示。要更多完整的資訊,請見[John Gruber 原本的規格](http://daringfireball.net/projects/markdown/)[Github 偏好的 Markdown(簡寫為GFM)資訊頁](http://github.github.com/github-flavored-markdown/)
    這篇文章旨在作為快速參考與展示。要更多完整的資訊,請見 [John Gruber 原本的規格](http://daringfireball.net/projects/markdown/) [Github 偏好的 Markdown(Github-flavored Markdown,簡寫為GFM)資訊頁](http://github.github.com/github-flavored-markdown/)

    如果你正在找 Markdown Here 的小抄(Cheatsheet),這裡也有一篇。你也可以看看更多 Markdown 的工具。
    如果你正在找 Markdown Here 的小抄(Cheatsheet),[這裡](https://github.com/adam-p/markdown-here/wiki/Markdown-Here-Cheatsheet)也有一篇。你也可以看看更多 Markdown 的工具。

    譯註:可以參考這份[中文版文件](http://markdown.tw/),有更詳盡的 Markdown 語法說明。

    ##### 目錄

    ##### Table of Contents
    [Headers](#headers)
    [Emphasis](#emphasis)
    [Lists](#lists)
    @@ -28,7 +31,7 @@
    ##### H5
    ###### H6
    你也可以使用下劃線的方式標記H1與H2
    你也可以使用下劃線的方式標記 H1 與 H2
    Alt-H1
    ======
    @@ -44,7 +47,7 @@ Alt-H2
    ##### H5
    ###### H6

    你也可以使用下劃線的方式標記H1與H2
    你也可以使用下劃線的方式標記 H1 與 H2

    Alt-H1
    ======
    @@ -117,7 +120,7 @@ Alt-H2
    + 或加號

    <a name="links"/>
    ## Links
    ## 連結

    有兩個方法可以建立連結

    @@ -193,7 +196,7 @@ http://www.example.com 或 <http://www.example.com> 甚至有時候 example.com
    <a name="code"/>
    ## 程式碼與語法高亮

    程式碼區塊是 Markdown 規格的一部分,不過語法高亮不是。無論如何,許多渲染器──如Github的和 *Markdown Here* ──支援語法高亮。每個渲染器支援的程式語言,以及程式語言的名字寫法都不一樣。*Markdown Here* 支援幾十種語言(以及不一定是真的程式語言,像 diffs 與 HTTP headers)的語法高亮;要看完整的列表,以及語言的名稱,請見 [highlight.js 的示範頁](http://softwaremaniacs.org/media/soft/highlight/test.html)
    程式碼區塊是 Markdown 規格的一部分,不過語法高亮不是。無論如何,許多渲染器──如 Github 和 *Markdown Here* ──支援語法高亮。每個渲染器支援的程式語言,以及程式語言的名字寫法都不一樣。*Markdown Here* 支援幾十種語言(以及不一定是真的程式語言,像 diffs 與 HTTP headers)的語法高亮;要看完整的列表,以及語言的名稱,請見 [highlight.js 的示範頁](http://softwaremaniacs.org/media/soft/highlight/test.html)


    ```no-highlight
    @@ -217,7 +220,7 @@ print s

    ```
    沒有指定程式語言,所以沒有語法高亮。
    不過,我們可以放進一個 &lt;b&gt;標籤&lt;/b&gt;
    不過,我們可以放進一個 <b>標籤</b>
    ```
    </code></pre>

    @@ -234,8 +237,8 @@ print s
    ```

    ```
    沒有指定程式語言,所以 Markdown Here 沒有語法高亮(在Github上可能不一樣)。
    不過,我們可以放進一個 &lt;b&gt;標籤&lt;/b&gt;
    沒有指定程式語言,所以 Markdown Here 沒有語法高亮(在Github 上可能不一樣)。
    不過,我們可以放進一個 <b>標籤</b>
    ```


    @@ -249,9 +252,9 @@ Markdown 的核心標準沒有表格,不過表格是 GFM 的一部分,而且
    | Tables | Are | Cool |
    | ------------- |:-------------:| -----:|
    | 第三欄 | 靠右對齊 | $1600 |
    | 第二欄 | 置中對齊 | $12 |
    | 斑馬條紋 | 是整齊的 | $1 |
    | 第三欄 | 靠右對齊 | $1600 |
    | 第二欄 | 置中對齊 | $12 |
    | 斑馬條紋 | 是整齊的 | $1 |
    每個標頭元件都要用至少三個破折號分隔開來。
    最外面的豎線可以省略,你也不需要讓原始的文字排列整齊。你也可以使用行內樣式的 Markdown。
    @@ -266,9 +269,9 @@ Markdown 的核心標準沒有表格,不過表格是 GFM 的一部分,而且

    | Tables | Are | Cool |
    | ------------- |:-------------:| -----:|
    | 第三欄 | 靠右對齊 | $1600 |
    | 第二欄 | 置中對齊 | $12 |
    | 斑馬條紋 | 是整齊的 | $1 |
    | 第三欄 | 靠右對齊 | $1600 |
    | 第二欄 | 置中對齊 | $12 |
    | 斑馬條紋 | 是整齊的 | $1 |

    每個標頭元件都要用至少三個破折號分隔開來。
    最外面的豎線可以省略,你也不需要讓原始的文字排列整齊。你也可以使用行內樣式的 Markdown。
    @@ -324,7 +327,7 @@ Markdown 的核心標準沒有表格,不過表格是 GFM 的一部分,而且
    ## 水平線

    ```
    三個或更多個...
    三個或更多個……
    ---
    @@ -339,7 +342,7 @@ ___
    下劃線
    ```

    三個或更多個...
    三個或更多個……

    ---

    @@ -356,7 +359,7 @@ ___
    <a name="lines"/>
    ## 斷行

    如果你想要學習斷行如何運作,我基本上建議最好就是實驗看看 ── 按&lt;Enter&gt;一下(也就是,插入一個換行符號),接著再按一次 (也就是,插入兩個換行符號),看看會發生什麼。你很快就會得到你想要的。「Markdown Toggle」是你的好朋友。
    如果你想要學習斷行如何運作,我基本上建議最好就是實驗看看 ── 按<Enter>一下(也就是,插入一個換行符號),接著再按一次 (也就是,插入兩個換行符號),看看會發生什麼。你很快就會得到你想要的。「Markdown Toggle」是你的好朋友。

    你可以試試看這裡的一些方式:

    @@ -365,23 +368,23 @@ ___
    兩個換行符號分開了這行和前面那一行,所以這會變成 **分開的段落** 。
    這行也是個分開的段落,不過...
    這行也是個分開的段落,不過……
    只有一個換行符號分開這行,所以這是 *同段落* 中的分開兩行。
    ```

    我們從這一行開始。

    兩個換行符號分開了這行和前面那一行,所以這會變成 **分開的段落**

    這行也是個分開的段落,不過...
    這行也是個分開的段落,不過……
    只有一個換行符號分開這行,所以這是 *同段落* 中的分開兩行。

    (技術提示: *Markdown Here* 使用 GFM 的換行,所以不用使用 Markdown 原先的兩個空格換行法。)

    <a name="videos"/>
    ## Youtube 影片

    Youtube影片無法直接被加入,不過我們可以加入圖片,在圖片上設定連結到影片,像這樣:
    Youtube 影片無法直接被加入,不過我們可以加入圖片,在圖片上設定連結到影片,像這樣:

    ```no-highlight
    <a href="http://www.youtube.com/watch?feature=player_embedded&v=YOUTUBE影片ID放在這裡
  2. @billy3321 billy3321 revised this gist Jun 14, 2016. 1 changed file with 1 addition and 1 deletion.
    2 changes: 1 addition & 1 deletion Markdown Cheatsheet 中文版.md
    Original file line number Diff line number Diff line change
    @@ -396,7 +396,7 @@ alt="圖片 ALT 文字放在這裡" width="240" height="180" border="10" /></a>
    [![圖片 ALT 文字放在這裡](http://img.youtube.com/vi/YOUTUBE影片ID放在這裡/0.jpg)](http://www.youtube.com/watch?v=YOUTUBE影片ID放在這裡)
    ```

    可以再git commit 裡面用 #bugID 的方式引用一個 bug,比如說 #1
    可以在 `git commit` 裡面用 #bugID 的方式引用一個 bug,比如說 #1

    ---

  3. @billy3321 billy3321 revised this gist Jun 14, 2016. 1 changed file with 1 addition and 5 deletions.
    6 changes: 1 addition & 5 deletions Markdown Cheatsheet 中文版.md
    Original file line number Diff line number Diff line change
    @@ -1,11 +1,7 @@

    這篇文章旨在作為快速參考與展示。要更多完整的資訊,請見[John Gruber 原本的規格](http://daringfireball.net/projects/markdown/)[Github 偏好的 Markdown(簡寫為GFM)資訊頁](http://github.github.com/github-flavored-markdown/)

    This is intended as a quick reference and showcase. For more complete info, see [John Gruber's original spec](http://daringfireball.net/projects/markdown/) and the [Github-flavored Markdown info page](http://github.github.com/github-flavored-markdown/).

    如果你正在找 Markdown Here 的小抄,這裡也有一篇。你也可以看看更多 Markdown 的工具。

    Note that there is also a [Cheatsheet specific to Markdown Here](./Markdown-Here-Cheatsheet) if that's what you're looking for. You can also check out [more Markdown tools](./Other-Markdown-Tools).
    如果你正在找 Markdown Here 的小抄(Cheatsheet),這裡也有一篇。你也可以看看更多 Markdown 的工具。

    ##### Table of Contents
    [Headers](#headers)
  4. @billy3321 billy3321 created this gist Jun 14, 2016.
    409 changes: 409 additions & 0 deletions Markdown Cheatsheet 中文版.md
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,409 @@

    這篇文章旨在作為快速參考與展示。要更多完整的資訊,請見[John Gruber 原本的規格](http://daringfireball.net/projects/markdown/)[Github 偏好的 Markdown(簡寫為GFM)資訊頁](http://github.github.com/github-flavored-markdown/)

    This is intended as a quick reference and showcase. For more complete info, see [John Gruber's original spec](http://daringfireball.net/projects/markdown/) and the [Github-flavored Markdown info page](http://github.github.com/github-flavored-markdown/).

    如果你正在找 Markdown Here 的小抄,這裡也有一篇。你也可以看看更多 Markdown 的工具。

    Note that there is also a [Cheatsheet specific to Markdown Here](./Markdown-Here-Cheatsheet) if that's what you're looking for. You can also check out [more Markdown tools](./Other-Markdown-Tools).

    ##### Table of Contents
    [Headers](#headers)
    [Emphasis](#emphasis)
    [Lists](#lists)
    [Links](#links)
    [Images](#images)
    [Code and Syntax Highlighting](#code)
    [Tables](#tables)
    [Blockquotes](#blockquotes)
    [Inline HTML](#html)
    [Horizontal Rule](#hr)
    [Line Breaks](#lines)
    [Youtube videos](#videos)

    <a name="headers"/>
    ## 標題

    ```no-highlight
    # H1
    ## H2
    ### H3
    #### H4
    ##### H5
    ###### H6
    你也可以使用下劃線的方式標記H1與H2:
    Alt-H1
    ======
    Alt-H2
    ------
    ```

    # H1
    ## H2
    ### H3
    #### H4
    ##### H5
    ###### H6

    你也可以使用下劃線的方式標記H1與H2:

    Alt-H1
    ======

    Alt-H2
    ------

    <a name="emphasis"/>
    ## 重點

    ```no-highlight
    重點,又被稱為斜體,在兩邊加上 *星號* 或是 _下劃線_ 。
    更強的重點,又稱為粗體,在兩邊加上 **兩個星號** 或是 __兩個下劃線__ 。
    也可以用 **星號與 _下劃線_** 結合重點。
    刪除線使用兩個波浪符號。 ~~刪除這個。~~
    ```

    重點,又被稱為斜體,在兩邊加上 *星號* 或是 _下劃線_

    更強的重點,又稱為粗體,在兩邊加上 **兩個星號** 或是 __兩個下劃線__

    也可以用 **星號與 _下劃線_** 結合重點。

    刪除線使用兩個波浪符號。 ~~刪除這個。~~


    <a name="lists"/>
    ## 列表

    (在這個例子裡,前置與後面的空白以點的方式顯示:⋅)
    (In this example, leading and trailing spaces are shown with with dots: ⋅)

    ```no-highlight
    1. 第一個有序列表項目
    2. 另一個項目
    ⋅⋅* 無序子列表
    1. 實際數字不重要,只要它是一個數字
    ⋅⋅1. 有序子列表
    4. 與其他項目
    ⋅⋅⋅要在列表項目下加入段落,只要縮進就好了。注意前面的空白行,以及前置的空白(至少要一個空白,不過我們在這裡會使用三個空白以剛好對齊原始的文字)。
    ⋅⋅⋅要使文字段行而不會成為新的段落,你只需要在後面加上兩個空白。⋅⋅
    ⋅⋅⋅注意這行已經分開了,不過還是在同樣的段落中。
    ⋅⋅⋅(如果不要求後面的兩個空格,就為伴了典型的 GFM 斷行格式。)
    * 無序列表可以使用星號
    - 或減號
    + 或加號
    ```

    1. 第一個有序列表項目
    2. 另一個項目
    * 無序子列表
    1. 實際數字不重要,只要它是一個數字
    1. 有序子列表
    4. 與其他項目

    要在列表項目下加入段落,只要縮進就好了。注意前面的空白行,以及前置的空白(至少要一個空白,不過我們在這裡會使用三個空白以剛好對齊原始的文字)。

    要使文字段行而不會成為新的段落,你只需要在後面加上兩個空白。
    注意這行已經分開了,不過還是在同樣的段落中。
    (如果不要求後面的兩個空格,就為伴了典型的 GFM 斷行格式。)

    * 無序列表可以使用星號
    - 或減號
    + 或加號

    <a name="links"/>
    ## Links

    有兩個方法可以建立連結

    ```no-highlight
    [這是一個行內樣式的連結](https://www.google.com)
    [這是一個加上標題的行內樣式連結](https://www.google.com "Google 的首頁")
    [這是一個引用樣式的連結][任意不區分大小寫的文字]
    [以相對的文件路徑引用其他文件](../blob/master/LICENSE)
    [可以用數字來宣告一個引用樣式的連結][1]
    或讓他空白並使用[連結文字本身]。
    網址,或是尖括號中的網址會自動轉換成連結。
    http://www.example.com 或 <http://www.example.com> 甚至有時候 example.com 也可以(只是舉例,Github上無效)。
    引用連結可以在一些文字後面。
    [任意不區分大小寫的文字]: https://www.mozilla.org
    [1]: http://slashdot.org
    [連結文字本身]: http://www.reddit.com
    ```

    [這是一個行內樣式的連結](https://www.google.com)

    [這是一個加上標題的行內樣式連結](https://www.google.com "Google 的首頁")

    [這是一個引用樣式的連結][任意不區分大小寫的文字]

    [以相對的文件路徑引用其他文件](../blob/master/LICENSE)

    [可以用數字來宣告一個引用樣式的連結][1]

    或讓他空白並使用[連結文字本身]

    網址,或是尖括號中的網址會自動轉換成連結。
    http://www.example.com<http://www.example.com> 甚至有時候 example.com 也可以(只是舉例,Github上無效)。

    引用連結可以在一些文字後面。

    [任意不區分大小寫的文字]: https://www.mozilla.org
    [1]: http://slashdot.org
    [連結文字本身]: http://www.reddit.com

    <a name="images"/>
    ## Images

    ```no-highlight
    這是我們的 Logo(把游標指向 Logo 可以看到標題文字)
    行內樣式:
    ![alt 文字](https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png "Logo 標題文字 1")
    引用樣式:
    ![alt 文字][logo]
    [logo]: https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png "Logo 標題文字 2"
    ```

    這是我們的 Logo(把游標指向 Logo 可以看到標題文字)

    行內樣式:
    ![alt 文字](https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png "Logo 標題文字 1")

    引用樣式:
    ![alt 文字][logo]

    [logo]: https://github.com/adam-p/markdown-here/raw/master/src/common/images/icon48.png "Logo 標題文字 2"

    <a name="code"/>
    ## 程式碼與語法高亮

    程式碼區塊是 Markdown 規格的一部分,不過語法高亮不是。無論如何,許多渲染器──如Github的和 *Markdown Here* ──支援語法高亮。每個渲染器支援的程式語言,以及程式語言的名字寫法都不一樣。*Markdown Here* 支援幾十種語言(以及不一定是真的程式語言,像 diffs 與 HTTP headers)的語法高亮;要看完整的列表,以及語言的名稱,請見 [highlight.js 的示範頁](http://softwaremaniacs.org/media/soft/highlight/test.html)


    ```no-highlight
    行內的 `程式碼` 用 `反引號` 包圍起來。
    Inline `code` has `back-ticks around` it.
    ```

    行內的 `程式碼``反引號` 包圍起來。

    程式碼區塊可以用只有三個反引號<code>```</code>的一行圍起來,或是以四個空格縮排。我建議用三個反引號的方式圍起來 ── 這比較簡單,而且只有這個方式支援語法高亮。

    <pre lang="no-highlight"><code>```javascript
    var s = "JavaScript 語法高亮";
    alert(s);
    ```

    ```python
    s = "Python 語法高亮"
    print s
    ```

    ```
    沒有指定程式語言,所以沒有語法高亮。
    不過,我們可以放進一個 &lt;b&gt;標籤&lt;/b&gt;
    ```
    </code></pre>



    ```javascript
    var s = "JavaScript 語法高亮";
    alert(s);
    ```

    ```python
    s = "Python 語法高亮"
    print s
    ```

    ```
    沒有指定程式語言,所以 Markdown Here 沒有語法高亮(在Github上可能不一樣)。
    不過,我們可以放進一個 &lt;b&gt;標籤&lt;/b&gt;。
    ```


    <a name="tables"/>
    ## 表格

    Markdown 的核心標準沒有表格,不過表格是 GFM 的一部分,而且 *Markdown Here* 支援表格。這是在電子郵件中加入表格的好方法 - 本來是需要從其他應用程式複製貼上的工作。

    ```no-highlight
    冒號可以用來標示欄位的對齊方式。
    | Tables | Are | Cool |
    | ------------- |:-------------:| -----:|
    | 第三欄 | 靠右對齊 | $1600 |
    | 第二欄 | 置中對齊 | $12 |
    | 斑馬條紋 | 是整齊的 | $1 |
    每個標頭元件都要用至少三個破折號分隔開來。
    最外面的豎線可以省略,你也不需要讓原始的文字排列整齊。你也可以使用行內樣式的 Markdown。
    不 | 漂亮 | 的文字
    --- | --- | ---
    *依然* | `渲染的` | **很好**
    1 | 2 | 3
    ```

    冒號可以用來標示欄位的對齊方式。

    | Tables | Are | Cool |
    | ------------- |:-------------:| -----:|
    | 第三欄 | 靠右對齊 | $1600 |
    | 第二欄 | 置中對齊 | $12 |
    | 斑馬條紋 | 是整齊的 | $1 |

    每個標頭元件都要用至少三個破折號分隔開來。
    最外面的豎線可以省略,你也不需要讓原始的文字排列整齊。你也可以使用行內樣式的 Markdown。

    不 | 漂亮 | 的文字
    --- | --- | ---
    *依然* | `渲染的` | **很好**
    1 | 2 | 3

    <a name="blockquotes"/>
    ## 引用文字

    ```no-highlight
    > 在電子郵件中,引用文字可以很方便的模擬回應的文字。
    > 這行也在同樣的引用區塊。
    引用區塊結束
    > 就算這行很長,只要包裹的好,依然可以很好的被引用。哦,我們繼續寫以保證每個人都確實的被包在裡面。喔,你也可以在引用文字中 *放入* 其他 **Markdown** 語法。
    ```

    > 在電子郵件中,引用文字可以很方便的模擬回應的文字。
    > 這行也在同樣的引用區塊。
    引用區塊結束

    > 就算這行很長,只要包裹的好,依然可以很好的被引用。哦,我們繼續寫以保證每個人都確實的被包在裡面。喔,你也可以在引用文字中 *放入* 其他 **Markdown** 語法。
    <a name="html"/>
    ## 行內 HTML

    你也可以在 Markdown 裡面撰寫原始的 HTML,這些 HTML 一樣大多數運作的很好。

    ```no-highlight
    <dl>
    <dt>定義列表</dt>
    <dd>有時候,人們偶爾會用到。</dd>
    <dt>在 HTML 中撰寫 Markdown</dt>
    <dd>*無法* 運作的 **非常** 好。改用 HTML<em>標籤</em>。</dd>
    </dl>
    ```

    <dl>
    <dt>定義列表</dt>
    <dd>有時候,人們偶爾會用到。</dd>

    <dt>在 HTML 中撰寫 Markdown</dt>
    <dd>*無法* 運作的 **非常** 好。改用 HTML<em>標籤</em>。</dd>
    </dl>

    <a name="hr"/>
    ## 水平線

    ```
    三個或更多個...
    ---
    連字符
    ***
    星號
    ___
    下劃線
    ```

    三個或更多個...

    ---

    連字符

    ***

    星號

    ___

    下劃線

    <a name="lines"/>
    ## 斷行

    如果你想要學習斷行如何運作,我基本上建議最好就是實驗看看 ── 按&lt;Enter&gt;一下(也就是,插入一個換行符號),接著再按一次 (也就是,插入兩個換行符號),看看會發生什麼。你很快就會得到你想要的。「Markdown Toggle」是你的好朋友。

    你可以試試看這裡的一些方式:

    ```
    我們從這一行開始。
    兩個換行符號分開了這行和前面那一行,所以這會變成 **分開的段落** 。
    這行也是個分開的段落,不過...
    只有一個換行符號分開這行,所以這是 *同段落* 中的分開兩行。
    ```

    我們從這一行開始。

    兩個換行符號分開了這行和前面那一行,所以這會變成 **分開的段落**

    這行也是個分開的段落,不過...
    只有一個換行符號分開這行,所以這是 *同段落* 中的分開兩行。

    (技術提示: *Markdown Here* 使用 GFM 的換行,所以不用使用 Markdown 原先的兩個空格換行法。)

    <a name="videos"/>
    ## Youtube 影片

    Youtube影片無法直接被加入,不過我們可以加入圖片,在圖片上設定連結到影片,像這樣:

    ```no-highlight
    <a href="http://www.youtube.com/watch?feature=player_embedded&v=YOUTUBE影片ID放在這裡
    " target="_blank"><img src="http://img.youtube.com/vi/YOUTUBE影片ID放在這裡/0.jpg"
    alt="圖片 ALT 文字放在這裡" width="240" height="180" border="10" /></a>
    ```

    或是,用單純的 Markdown,不過會無法改變圖片的大小與邊框:


    ```no-highlight
    [![圖片 ALT 文字放在這裡](http://img.youtube.com/vi/YOUTUBE影片ID放在這裡/0.jpg)](http://www.youtube.com/watch?v=YOUTUBE影片ID放在這裡)
    ```

    可以再git commit 裡面用 #bugID 的方式引用一個 bug,比如說 #1

    ---

    License: [CC-BY](https://creativecommons.org/licenses/by/3.0/)

    翻譯自 [adam-p](https://github.com/adam-p/)[wiki](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)