8. DataTables Markdown

Markdown 是一种纯文本格式化语法，最初由 John Gruber 创建，现在在网上得到广泛使用。它旨在提供一组简单易用的格式化规则，这些规则可以应用于文档，将其从易于阅读和编辑的纯文本格式转换为 HTML。

DataTables 项目在多个领域使用扩展形式的 Markdown

• 论坛帖子
• 网站页面评论
• DataTables 参考资源

语法

DataTables Markdown 遵循与 GitHub 风味 Markdown 相同的规则，并进行了一些扩展（见下文）。下文记录了 DataTables 使用的最常见的 Markdown 规则，但有关 Markdown 中支持的语法的完整文档，请参考

• John Gruber 的文档
• Markdown 速查表

扩展

如果你已经了解 Markdown，你会对 DataTables 使用的扩展感兴趣。这些扩展主要是为了添加轻松链接到不同 DataTables 参考文档或突出显示不同类型内联代码的功能

`-api x`, `-event x`, `-init x`，以及 `-button x` 代码链接可以（选择）带上一个 `e` 前缀，用来表示文档中的内容是一个 Editor API、事件、选项或按钮（Editor 拥有自己的文档）。

常规规则

Markdown 可以在大部分情况下实现透明度。只管像往常一样输入/发布评论，Markdown 就会将其转换成 HTML 格式。话虽如此，但是您可能需要在编写评论/博文时使用一些常规规则。

链接

只需输入一个以 `http://` 或 `https://` 开头的网址，即可自动创建链接，DataTables Markdown 会自动将其转换成 HTML 链接。其他方法是使用语法 `[text](address)` 明确创建链接。例如

Markdown 示例

[DataTables](https://datatables.net.cn)
[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

渲染后的示例

• 列表项
• 另一个列表项

1. 有序列表
2. 第二个项目

代码

DataTables Markdown 中提供了两种代码显示样式

• 内联代码
• 代码块

内联代码

在语句中引用变量名称等时，可以使用内联代码高亮显示。代码使用 `` 符号表示。同样，请记住，在 DataTables Markdown 中，可以使用 ``-* _x_` 表示初始化选项、API 方法、事件或类型应显示为配有指向参考文档的链接的内联代码（见上文）。

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

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

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