8. DataTables Markdown

Markdown 是一種純文字格式語法，最初由 John Gruber 建立，現在廣泛用於網路上。它旨在提供一組易於使用的格式規則，可以應用於文件，將其從易於閱讀和編輯的純文字格式轉換為 HTML。

DataTables 專案在多個區域使用了 Markdown 的擴充形式

論壇貼文
網站頁面註解
DataTables 參考資料來源

語法

DataTables Markdown 遵循與 GitHub Flavoured Markdown 相同的規則，並有一些擴充功能（見下文）。DataTables 使用的最常見 Markdown 規則如下所述，但如需完整了解 Markdown 中支援的語法，請參閱

擴充功能

如果您已經了解 Markdown，您會對 DataTables 使用的擴充功能感興趣。這些擴充功能主要是為了增加輕鬆連結到不同 DataTables 參考文件的功能，或突出顯示不同類型的內嵌程式碼

Markdown 語法	動作	Markdown 範例	呈現的範例
`-api x`	連結到 API 方法 x 的參考文件	`-api row().data()`	`row().data()`
`-button x`	連結到按鈕 x 的參考文件	`-button pdf`	`pdf`
`-event x`	連結到事件 x 的參考文件	`-event draw`	`draw`
`-init x`	連結到初始化選項 x 的參考文件	`-init scrollY`	`scrollY`
`-type x`	連結到資料類型 x 的參考文件	`-type row-selector`	`row-selector`
`-tag x`	將程式碼突出顯示為 HTML 標籤	`-tag tbody`	`tbody`
`-path x`	將程式碼突出顯示為檔案路徑	`-path /home/datatables`	`/home/datatables`
`-string x`	將程式碼突出顯示為字串文字	`-string full_numbers`	`full_numbers`

`-api x`、`-event x`、`-init x` 和 `-button x` 程式碼連結可以選擇加上 `e` 前綴，表示它所記錄的是 Editor API、事件、選項或按鈕（Editor 有自己的文件）。

常用規則

在大多數情況下，Markdown 是透明的。只需像平常一樣輸入註解/貼文，Markdown 就會將其格式化為 HTML。儘管如此，在撰寫註解/貼文時，您可能想要使用一些常用規則。

連結

只需輸入以 `http://` 或 `https://` 開頭的網址，DataTables Markdown 就會自動將其轉換為 HTML 連結，即可自動建立連結。另一種方法是使用語法 `[文字](網址)` 顯式建立連結。例如

Markdown 範例

[DataTables](https://datatables.dev.org.tw)
[DataTables on GitHub](https://github.com/DataTables/)

呈現的範例

DataTables
GitHub 上的 DataTables

斜體/粗體

Markdown 交替使用 `*` 和 `_` 字元表示斜體和粗體文字（儘管結尾字元必須與開頭字元匹配！）。用單個 `*` 或 `_` 括住的單字或片語會顯示為斜體文字。用雙個 `**` 或 `__` 括住的單字或片語會顯示為粗體文字。

Markdown 範例

This is *italic text* as _is this_. Meanwhile, this is **bold text**, as __is this__.

呈現的範例

這是 斜體文字，這也是 斜體文字。同時，這是 粗體文字，這也是 粗體文字。

引文

Markdown 中的引文與我們在電子郵件中熟悉的引文類似 - 也就是說，每行引文前面都有一個 `>` 字元和一個空格。文字區塊可以用 `>` 字元為區塊中的每行加上前綴來引述 - Markdown 會自動將它們合併為單個引述區塊。

Markdown 範例

> Quoted text

呈現的範例

引述文字

清單

在行首加上星號和空格 (`*`) 來建立無序清單。在行首加上數字、句點和空格 (`1.`) 來建立有序清單

Markdown 範例

* List item
* Another list item

1. Ordered list
1. Second item

呈現的範例

清單項目
另一個清單項目

有序清單
第二個項目

程式碼

DataTables Markdown 中有兩種顯示程式碼的方式

內嵌程式碼
程式碼區塊

內嵌程式碼

在句子中引用變數名稱等時，內嵌程式碼高亮度顯示非常有用。程式碼使用 ` ` 符號表示。請記住，在 DataTables Markdown 中，您也可以使用 ` `-* _x_`` 表示要將初始化選項、API 方法、事件或類型顯示為帶有參考文件連結的內嵌程式碼（請參閱上文）。

Markdown 範例

When using `-init scrollX` set its value to be `true`.

呈現的範例

當使用 scrollX 時，將其值設定為 `true`。

帶有語法高亮度顯示的程式碼區塊

DataTables Markdown 使用的第二種類型的程式碼顯示符合 GitHub Flavoured Markdown，以顯示較大的程式碼區段。這是透過三個 `` ` `` 字元完成的，後面可選擇加上用於語法高亮度顯示的語言識別碼（js、html、xml、css 或 php），然後是換行符號。區塊以另一行三個 `` ` `` 字元結束。

Markdown 範例

  ```js
  $(document).ready( function () {
    var table = $('#myTable').DataTable();
    // ...
  } );
  ```

呈現的範例

$(document).ready( function () {
  var table = $('#myTable').DataTable();
  // ...
} );