iT邦幫忙

Markdown說明

本頁先介紹什麼是 Markdown, 以及它的語法

標題

將 # 符號置於標題前面便能將文字顯示為標題大小 (# 的數量決定標題大小,例如 # 便是<H1>; ## 便是<H2>)

# 這是H1標題
## 這是H2標題
### 這是H3標題
#### 這是H4標題
##### 這是H5標題
###### 這是H6標題

結果顯示如下圖

引用文字(Blockquotes)

你可以利用 > 符號顯示引用文字,範例如下:

> 一分耕耘,一分收獲

結果顯示如下圖

文字格式(Styling text)

在文字前後加*,便顯示斜體
在文字前後加**,便顯示粗體
例如:

**粗體**
*斜體*

結果顯示如下圖

列點(List)

無序列點:

可以用「*」或「-」列點,「*」和「-」與後面的文字之間要空一格,否則無法辨識。
例如:

* 星星
* 月亮
* 太陽

- 星星
- 月亮
- 太陽

結果顯示如下圖

有序列表:

就是1,2,3,4…的列表,這個很直覺,就直接以1、2、3、4…列點即可。
注意:列點與後面的文字之間要空一格。
範例如下:

1. 第一點
2. 第二點
3. 第三點

結果顯示如下圖

巢狀列表

需縮排的列表,使用半型空白空3格,範例如下:

1. Item 1
   1. A corollary to the above item.
   2. Yet another point to consider.
2. Item 2
   * A corollary that does not need to be ordered.
   * This is indented four spaces, because it's two spaces further than the item above.
   * You might want to consider making a new list.
3. Item 3

結果顯示如下圖

Code Formatting

內嵌格式(Inline formats)

「`」反引號內的全部內容皆顯示原形,沒有特殊格式。
如何打出反引號呢? 就鍵盤數字1隔壁那個。要打半型喔~
範例如下:

`
VMware正式釋出新一代虛擬化平臺vShpere 6,同時發布7種語言,包括正體中文,
虛擬機器終於可以跨資料中心長距離轉移
`

結果顯示如下圖

多行(Multiple Lines)

在文字區塊的上下方輸入三個反引號「```」就可以了
範例如下:

```
x = 0
x = 2 + 2
what is x
```

結果顯示如下圖

刪除線(Strikethrough)

“~~”與”~~”中間的文字會加上刪除線
範例如下:

~~好大的本事啊!~~

結果顯示如下圖

程式碼與語法高亮標記

使用3個反引號(鍵盤1左邊那個「`」)上下包夾,或者四個空格就可以mark出程式碼區塊。
作法如下:

```
function test() {
  console.log("notice the blank line before this function?");
}
```
或者程式前方空4格,如下:
    function fancyAlert(arg) {
      if(arg) {
        $.facebox({div:'#foo'})
      }
    }

結果顯示如下圖

程式碼若希望有高亮(highlight)標記效果,只能選擇反引號的作法,並在其後寫出指定的程式語言。若無沒有指定語言,目前預設採取HTML高亮標記。
例如:

```javascript
 var s = "JavaScript syntax highlighting";
 alert(s);
 s = "Python syntax highlighting"
 print s
```

結果顯示如下圖

或者

```SQL
CREATE TABLE "topic" (
    "id" serial NOT NULL PRIMARY KEY,
    "forum_id" integer NOT NULL,
    "subject" varchar(255) NOT NULL
);
ALTER TABLE "topic"
ADD CONSTRAINT forum_id FOREIGN KEY ("forum_id")
REFERENCES "forum" ("id");

-- Initials
insert into "topic" ("forum_id", "subject")
values (2, 'D''artagnian');
```

結果顯示如下圖

iT邦幫忙支援語法高亮標記的程式語言列表如下:

表格(Table)

利用分割符號”-“和”|”建立表格。
範例如下:

姓名 | 住址
------------- | -------------
李大華 | 桃園
張小明 | 高雄

結果顯示如下圖