数据表格¶

Material for MkDocs 定义了数据表格的默认样式，这是在项目文档中呈现表格数据的绝佳方式。此外，像 sortable tables 这样的自定义功能可以通过第三方库和一些 additional JavaScript 实现。

配置¶

此配置启用 Markdown 表格支持，通常默认情况下应已启用，但为了确保，请在 mkdocs.yml 中添加以下行：

markdown_extensions:
  - tables

查看其他配置选项：

Tables

使用¶

数据表格可以在项目文档中的任何位置使用，并且可以包含任意的 Markdown，包括内联代码块，以及 icons and emojis:

数据表

| 方法        | 描述                               |
| ----------- | ---------------------------------- |
| `GET`       | :material-check:     获取资源     |
| `PUT`       | :material-check-all: 更新资源     |
| `DELETE`    | :material-close:     删除资源     |

方法	描述
`GET`	获取资源
`PUT`	更新资源
`DELETE`	删除资源

列对齐¶

如果您想将特定列对齐到 left、center 或 right，可以使用 regular Markdown syntax 在分隔符的开头和/或结尾放置 : 字符。

左对齐居中右对齐

数据表，列左对齐

| 方法        | 描述                               |
| :---------- | :--------------------------------- |
| `GET`       | :material-check:     获取资源     |
| `PUT`       | :material-check-all: 更新资源     |
| `DELETE`    | :material-close:     删除资源     |

方法	描述
`GET`	获取资源
`PUT`	更新资源
`DELETE`	删除资源

数据表，列居中

| 方法        | 描述                               |
| :---------: | :--------------------------------: |
| `GET`       | :material-check:     获取资源     |
| `PUT`       | :material-check-all: 更新资源     |
| `DELETE`    | :material-close:     删除资源     |

方法	描述
`GET`	获取资源
`PUT`	更新资源
`DELETE`	删除资源

数据表，列右对齐

| 方法        | 描述                               |
| ----------: | ----------------------------------: |
| `GET`       | :material-check:     获取资源     |
| `PUT`       | :material-check-all: 更新资源     |
| `DELETE`    | :material-close:     删除资源     |

方法	描述
`GET`	获取资源
`PUT`	更新资源
`DELETE`	删除资源

自定义¶

可排序表格¶

如果您想使数据表格可排序，可以添加 tablesort，它与 Material for MkDocs 原生集成，并且也可以通过 additional JavaScript 实现 instant loading:

docs/javascripts/tablesort.js mkdocs.yml

document$.subscribe(function() {
  var tables = document.querySelectorAll("article table:not([class])")
  tables.forEach(function(table) {
    new Tablesort(table)
  })
})

extra_javascript:
  - https://unpkg.com/tablesort@5.3.0/dist/tablesort.min.js
  - javascripts/tablesort.js

应用自定义后，可以通过点击列来对数据表格进行排序：

数据表，列可排序

| 方法        | 描述                               |
| ----------- | ---------------------------------- |
| `GET`       | :material-check:     获取资源     |
| `PUT`       | :material-check-all: 更新资源     |
| `DELETE`    | :material-close:     删除资源     |

方法	描述
`GET`	获取资源
`PUT`	更新资源
`DELETE`	删除资源

请注意，tablesort 提供了替代的比较实现，如数字、文件大小、日期和月份名称。有关更多信息，请参见 [tablesort documentation]。

从文件导入表格¶

插件 mkdocs-table-reader-plugin 允许您从 CSV 或 Excel 文件导入数据。