Skip to content

列表

¥Lists

Material for MkDocs 支持多种满足不同用例的列表,包括通过标准 Markdown 支持的无序列表有序列表,以及通过扩展支持的定义列表任务列表

¥Material for MkDocs supports several flavors of lists that cater to different use cases, including unordered lists and ordered lists, which are supported through standard Markdown, as well as definition lists and task lists, which are supported through extensions.

配置

¥Configuration

此配置允许使用定义列表和任务列表,它们都不属于标准 Markdown 语法。将以下几行添加到mkdocs.yml

¥This configuration enables the use of definition lists and tasks lists, which are both not part of the standard Markdown syntax. Add the following lines to mkdocs.yml:

markdown_extensions:
  - def_list
  - pymdownx.tasklist:
      custom_checkbox: true

查看其他配置选项:

¥See additional configuration options:

用法

¥Usage

使用无序列表

¥Using unordered lists

无序列表可以通过在行首添加-*+列表标记来编写,这些标记可以互换使用。此外,所有类型的列表都可以相互嵌套:

¥Unordered lists can be written by prefixing a line with a -, * or + list marker, all of which can be used interchangeably. Furthermore, all flavors of lists can be nested inside each other:

List, unordered
- Nulla et rhoncus turpis. Mauris ultricies elementum leo. Duis efficitur
  accumsan nibh eu mattis. Vivamus tempus velit eros, porttitor placerat nibh
  lacinia sed. Aenean in finibus diam.

    * Duis mollis est eget nibh volutpat, fermentum aliquet dui mollis.
    * Nam vulputate tincidunt fringilla.
    * Nullam dignissim ultrices urna non auctor.
  • Nulla et rhoncus turpis。 Mauris ultricies leo 元素。 Duis efficitur Accumsan nibh eu mattis。 Vivamus tempus velit eros,porttitor placerat nibh lacinia sed。埃涅安 (Aenean) 直径为 finibus。 Duis mollis est eget nibh volutpat,发酵aliquet dui mollis。 Nam vulputatetincidunt fringilla。 Nullam dignissim ultrices urna non actor。

使用有序列表

¥Using ordered lists

有序列表必须以数字开头,后跟一个点。数字不必连续,可以全部设置为1. ,因为它们在渲染时会重新编号:

¥Nulla et rhoncus turpis. Mauris ultricies elementum leo. Duis efficitur accumsan nibh eu mattis. Vivamus tempus velit eros, porttitor placerat nibh lacinia sed. Aenean in finibus diam.

List, ordered
1.  Vivamus id mi enim. Integer id turpis sapien. Ut condimentum lobortis
    sagittis. Aliquam purus tellus, faucibus eget urna at, iaculis venenatis
    nulla. Vivamus a pharetra leo.

    1.  Vivamus venenatis porttitor tortor sit amet rutrum. Pellentesque aliquet
        quam enim, eu volutpat urna rutrum a. Nam vehicula nunc mauris, a
        ultricies libero efficitur sed.

    2.  Morbi eget dapibus felis. Vivamus venenatis porttitor tortor sit amet
        rutrum. Pellentesque aliquet quam enim, eu volutpat urna rutrum a.

        1.  Mauris dictum mi lacus
        2.  Ut sit amet placerat ante
        3.  Suspendisse ac eros arcu
  1. Vivamus id mi enim。智人 ID 的整数。 Ut condimentum lobortis sagittis。 Aliquam purustellus、faucibus eget urna at、iaculis venenatis nulla。 Vivamus a pharetra leo。 Vivamus venenatis porttitor totortor 坐 amet rutrum。 Pellentesque aliquet quam enim, eu volutpat urna rutrum a. Nam vehicula nunc mauris,一种超级自由的效率。 Morbi eget dapibus felis。 Vivamus venenatis porttitor totortor 坐 amet rutrum。 Pellentesque aliquet quam enim, eu volutpat urna rutrum a. Mauris dictum mi lacus Ut sat amet placerat ante Suspendisse ac eros arcu

    ¥Duis mollis est eget nibh volutpat, fermentum aliquet dui mollis.

使用定义列表

¥Using definition lists

启用定义列表后,可以使用简单的语法枚举任意键值对的列表,例如函数或模块的参数:

¥Ordered lists must start with a number immediately followed by a dot. The numbers do not need to be consecutive and can be all set to 1., as they will be re-numbered when rendered:

Definition list
`Lorem ipsum dolor sit amet`

:   Sed sagittis eleifend rutrum. Donec vitae suscipit est. Nullam tempus
    tellus non sem sollicitudin, quis rutrum leo facilisis.

`Cras arcu libero`

:   Aliquam metus eros, pretium sed nulla venenatis, faucibus auctor ex. Proin
    ut eros sed sapien ullamcorper consequat. Nunc ligula ante.

    Duis mollis est eget nibh volutpat, fermentum aliquet dui mollis.
    Nam vulputate tincidunt fringilla.
    Nullam dignissim ultrices urna non auctor.
Lorem ipsum dolor sit amet

Sed sagittis eleifend rutrum。 Donec vitae suscipit est. Nullam tempus Tellus non sem sollicitudin, quis rut​​rum leo facilisis。

¥Vivamus id mi enim. Integer id turpis sapien. Ut condimentum lobortis sagittis. Aliquam purus tellus, faucibus eget urna at, iaculis venenatis nulla. Vivamus a pharetra leo.

Cras arcu libero

Aliquam metus eros,pretium sed nulla venenatis,faucibus auctor ex。 Proin ut eros sed sapien ullamcorper consequat。 Nunc ligula ante。

¥Vivamus venenatis porttitor tortor sit amet rutrum. Pellentesque aliquet quam enim, eu volutpat urna rutrum a. Nam vehicula nunc mauris, a ultricies libero efficitur sed.

Duis mollis est eget nibh volutpat,发酵aliquet dui mollis。 Nam vulputatetincidunt fringilla。 Nullam dignissim ultrices urna non actor。

¥Morbi eget dapibus felis. Vivamus venenatis porttitor tortor sit amet rutrum. Pellentesque aliquet quam enim, eu volutpat urna rutrum a.

使用任务列表

¥Using task lists

启用任务列表后,无序列表项可以添加前缀[ ]来呈现未选中的复选框,或添加前缀[x]来呈现选中的复选框,从而可以定义任务列表:

¥When Definition Lists is enabled, lists of arbitrary key-value pairs, e.g. the parameters of functions or modules, can be enumerated with a simple syntax:

Task list
- [x] Lorem ipsum dolor sit amet, consectetur adipiscing elit
- [ ] Vestibulum convallis sit amet nisi a tincidunt
    * [x] In hac habitasse platea dictumst
    * [x] In scelerisque nibh non dolor mollis congue sed et metus
    * [ ] Praesent sed risus massa
- [ ] Aenean pretium efficitur erat, donec pharetra, ligula non scelerisque
  • Lorem ipsum dolor sat amet,consectetur adipiscing elit

    ¥Nam vulputate tincidunt fringilla.

  • Vestibulum convallis sat amet nisi atincidunt In hach​​abitasseplatea dictumst In scelerisque nibh non dolor mollis congue sed et metus Praesent sed risus Massa

    ¥Nullam dignissim ultrices urna non auctor.

  • Aenean pretium efficiturerat、donec pharetra、ligula non scelerisque