跳转至

Data tables 数据表

Material for MkDocs 为数据表格定义了默认样式,这是一种在项目文档中呈现表格数据的极佳方式。此外,通过引入第三方库和额外的 JavaScript,还可以实现可排序表格等自定义功能。

使用方法

数据表格可以在项目文档的任何位置使用,支持包含内联代码块、图标以及表情符号等任意的 Markdown 内容。

数据表
<!-- (1)! -->
| 作者 | 诗篇|
<!-- (2)! -->
| --- | --- |
| 李白 | 《将进酒》|
| 杜甫 | 《春望》  |
| 韩愈 | 《师说》  |
  1. 这些|分隔符不对齐也是可以的
  2. 这些-想写多少都可以,甚至只有一个也是可以的
作者 诗篇
李白 《将进酒》
杜甫 《春望》
韩愈 《师说》

对齐方式

如果你需要将某一列的内容对齐到左侧、居中或右侧,可以在分隔符中使用 : 来实现。

左侧对齐的数据表
| 作者 | 诗篇|
| :--- | :--- |
| 李白 | 《将进酒》|
| 杜甫 | 《春望》  |
| 韩愈 | 《师说》  |
作者 诗篇
李白 《将进酒》
杜甫 《春望》
韩愈 《师说》
居中对齐的数据表
| 作者 | 诗篇|
| :--: | :--: |
| 李白 | 《将进酒》|
| 杜甫 | 《春望》  |
| 韩愈 | 《师说》  |
作者 诗篇
李白 《将进酒》
杜甫 《春望》
韩愈 《师说》
靠右对齐的数据表
| 作者 | 诗篇|
| ---: | ---: |
| 李白 | 《将进酒》|
| 杜甫 | 《春望》  |
| 韩愈 | 《师说》  |
作者 诗篇
李白 《将进酒》
杜甫 《春望》
韩愈 《师说》

自定义设置

表格排序

如果需要让数据表格支持排序,可以引入 tablesort,该功能已与 Material for MkDocs 原生集成,并通过额外的 JavaScript 支持即时加载。详见Sortable tables. 更多关于 tablesort 的内容详见tablesort.

从外部文件导入表格

使用插件mkdocs-table-reader-plugin,使得你能够从一个CSV或Excel文件中导入一个表格。