Admonition

Configuration¶

将以下行添加到 mkdocs.yml :

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences

其他配置选项： - Admonition 提示 - Details 详情 - SuperFences

每个支持的 Admonition 类型都有一个独特的图标，支持更改为主题自带的任何图标，支持自定义图标。将以下行添加到 mkdocs.yml 中：

theme:
  icon:
    admonition:
      <type>: <icon>

Usage¶

类型¶

note

abstract

info

Tip

tip

Success

success

Question

question

Warning

warning

Failure

failure

Danger

danger

Bug

bug

Example

example

Quote

quote

嵌套¶

Outer

outer

Inner

inner

可折叠的块¶

Note

可折叠

Note

可折叠且默认展开

内联块¶

提示框也可以呈现为内联块（例如，用于侧边栏），使用 inline + end 修饰符将其放置在右侧，或者仅使用 inline 修饰符将其放置在左侧：

inline end inline

Lorem ipsum

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et
euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo
purus auctor massa, nec semper lorem quam in massa.

!!! info inline end "Lorem ipsum"  
    Lorem ipsum dolor sit amet, consectetur  
    adipiscing elit. Nulla et euismod nulla.  
    Curabitur feugiat, tortor non consequat  
    finibus, justo purus auctor massa, nec  
    semper lorem quam in massa.

Use inline end to align to the right (left for rtl languages).

Lorem ipsum

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et
euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo
purus auctor massa, nec semper lorem quam in massa.

!!! info inline "Lorem ipsum"  
    Lorem ipsum dolor sit amet, consectetur  
    adipiscing elit. Nulla et euismod nulla.  
    Curabitur feugiat, tortor non consequat  
    finibus, justo purus auctor massa, nec  
    semper lorem quam in massa.

Use inline to align to the left (right for rtl languages).