[公告] 本站 markdown 說明 - 討論區

[公告] 本站 markdown 說明

visibility文章瀏覽次數 718 reply_all文章回覆數 7

特種兵

特種兵圖像(預設)

2019-08-01 14:27:33

From:211.23.21.202

一、說明

為因應文章多樣性及無障礙考量,本站提供教學、討論與精華三區發文時使用 markdown 格式。

讓使用者在純文字書寫環境下即可產出基本樣式與使用者互動之元素。

目前本站 markdown 規則如下:

二、規則

1.斜體

說明:斜體字

語法:用一對星號左右包夾

範例:

我是*斜體*字

效果:

我是斜體

2.粗體

說明:粗體字

語法:用二對星號左右包夾

範例:

我是**粗體**字

效果:

我是粗體

3.粗體加斜體

說明:粗體字加斜體字

語法:用三對星號左右包夾

範例:

我是***粗體加斜體***字

效果:

我是粗體加斜體

4.表格

說明:產生幾欄幾列的資料表格

語法: | 代表直線,- 代表標題與內容的分隔線,用空格將符號與資料隔開,表格上下要空行。

範例:產生三欄三列的表格

表格開始前要空行

| a | b | c |
| --- | --- | --- |
| android | book | clear |
| 三一 | 三二 | 三三 |

表格結束後要空行

效果:

a b c
android book clear
三一 三二 三三

補充:第二行的 --- 分格線,預設為表格欄位齊左,我們可以利用它來改變表格欄位內容對齊方式,:-- 齊左, :-: 齊中, --: 齊右

例如:

| :-- | :-: | --: | 此設定為 | 齊左 | 齊中 | 齊右 |
| :---- | :----: | ----: | 此設定為 | 齊左 | 齊中 | 齊右 |
| :- | : | -: | 此設定為 | 齊左 | 齊中 | 齊右 |
| : | : | : | 此設定為全部 齊中

5.有序清單

說明:產生有1,2,3編號的清單項目

語法:用數字開頭加小數點,點的右方必須空格,第一個項目的數字為該清單的起始編號,後序編號系統會自動加一,清單上下要空行。

範例:

清單開始前要空行

1. 你好
1. 我好
1. 大家好

清單結束後要空行

效果:

  1. 你好
  2. 我好
  3. 大家好

補充:清單結束後,文章前面不能亂空格,不然會被視為同一個清單中

6.無序清單

說明:產生有項目符號的清單

語法:用星號開頭,星號的右方必須空格,清單上下要空行。

範例:

清單開始前要空行

* 你好
* 我好
* 大家好

清單結束後要空行

效果:

  • 你好
  • 我好
  • 大家好

補充:清單結束後,文章前面不能亂空格,不然會被視為同一個清單中

兩種清單符號後面的空格不能使用 tab

7.標題

說明:產生各層級之大標題

語法:標題上空一行,井號右方需空一格,幾個井號就是第幾級標題,從1到6級。

注意:

  • 討論區、教學區與精華區:開放3,4,5,6級標題
  • 其他區域暫不開放此功能。

範例:

標題上空一行

### 第三級
內容

#### 第四級
內容

##### 第五級
內容

###### 第六級
內容

效果:

因為會把這篇文章原有的標題層級打亂,直接看本文的標題就是效果了。

8.連結

說明:產生一個連結,可讓使用者直接點擊,另開視窗進入該連結。

語法:一對中括號夾住連結說明,接著一對小括號包夾連結網址。

範例:

一般連結:
[NVDA 台灣](http://www.nvda.org.tw)
加上 title 的連結:
[NVDA 台灣](http://www.nvda.org.tw "點擊連結前往該站")

效果:

一般連結:
NVDA 台灣
加上 title 的連結:
NVDA 台灣

補充:還有另外一種風格的連結,就是當連結是插在文章之間時,不想讓網址讓整個文章看起來有點冗長,可以先寫好連結敘述,最後再把網址補在文末,連結的敘述必須對應正確

範例:

歡迎經常來 [NVDA 台灣]{} 逛逛喔。
其他文章的文字

[NVDA 台灣]: https://www.nvda.org.tw

另外,直接使用 http://www.nvda.org.tw 這樣會被視為純文字不轉換

9.圖片

說明:產生一張圖片,可直接在瀏覽器上顯示

語法:以驚嘆號開頭,接一對中括號夾住圖片說明,接著一對小括號包夾圖片網址。

範例:

![NVDA 台灣Logo](http://alex.nvda.org.tw/assets/logo.png)

效果:

NVDA 台灣Logo

10.程式碼區塊

說明:該區塊之文字將照原格式輸出。

語法:以一對三個反引號上下包夾,程式碼區塊上下要空行。

範例:

```
def ph():
print('hello')
print('world')

ph()
```

補充:如果是要插在行間又想保留原格式時,可用一個一對反引號包夾,如:

取得陣列的第一個原素為 `array[0]` 這樣就不會被轉換。

效果:

其實這篇文章的範例都是這樣打出來的,不然會被 markdown 解析成效果,這樣大家就看不到語法了。

11.內嵌 youtube 影片

說明:直接內嵌 youtube 播放頁框到文章中

語法:與連結相同,但連結網址是 youtube 影片連結,並且要在中括號加入 embed 關鍵字,其他說明可不輸入。

範例:

[embed](https://www.youtube.com/watch?v=6mYOfCzc1xw)

效果:

補充:若使用 youtube 網址為連結,不加入 embed 則視為一般網站連結

12.多層清單

說明:可能是有序包無序或無序包有序清單都可以。

語法:第一層如之前清單,第二層內縮至第一層的點後面的空格之後。

範例:

* 我是無序一
* 我是無序二
  1. 我是第二層有序一
  1. 我是第二層有序二
* 我是無序三
  1. 我是第二層有序一

效果:

  • 我是無序一
  • 我是無序二
    1. 我是第二層有序一
    2. 我是第二層有序二
  • 我是無序三
    1. 我是第二層有序一

13.分隔線

說明:產生一條分隔線

語法:三個連字號以上,需上下空行。

範例:

上面要空行

---

下面也要空行

補充:只要在同一行裡, 至少有三個 - , 都會轉換成分隔線, 以下範例皆可

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

效果:


※最後更新時間:2019-08-03 03:10:51 From:1.161.148.183 By:特種兵
※最後更新時間:2019-08-14 17:15:32 From:1.161.144.177 By:特種兵
※最後更新時間:2019-08-23 08:07:34 From:1.161.143.135 By:特種兵
※最後更新時間:2019-08-23 12:30:44 From:211.23.21.202 By:特種兵
※最後更新時間:2020-02-16 09:33:50 From:1.161.133.234 By:特種兵
※最後更新時間:2020-02-16 09:36:25 From:1.161.133.234 By:特種兵

留言

#1

Alex

Alex圖像

2019-08-01 15:23:17

From:110.28.164.244

太棒了👏
💪

#2

小羔羊

小羔羊圖像(預設)

2019-08-02 16:28:11

From:36.230.92.230

讚喔,特種兵老大辛苦了

#3

嘯傲俠羽

嘯傲俠羽圖像(預設)

2020-01-26 21:51:11

From:61.223.79.227

請問可以直接使用 html 標籤嗎?謝謝!

#4

特種兵

特種兵圖像(預設)

2020-01-28 10:51:45

From:1.161.128.113

不行

#5

貓貓蟲

貓貓蟲圖像

2020-02-02 22:18:41

From:220.132.235.31

由於安全性的考量 未來也不打算開放直接使用HTML語法

#6

特種兵

特種兵圖像(預設)

2020-02-02 23:30:04

From:1.161.144.116

如果要用 html 就不會推 markdown 了

#7

特種兵

特種兵圖像(預設)

2020-02-16 09:42:46

From:1.161.133.234

加上了效果與 youtube 語法的調整及三區都開放3-6級標題