Admonitions¶

Admonitions are special styled blocks for important information.

Note Title

This is a note admonition. Use it for supplementary information.

Pro Tip

The strip-number-prefix plugin works seamlessly with MkDocs Material's admonitions!

Warning

Make sure your file naming is consistent to avoid URL collisions.

Danger

Never use the same number prefix for multiple files in the same directory.

Success

Your documentation now has clean URLs!

Question

Did you know you can customize the prefix pattern?

Information

This plugin is compatible with all MkDocs themes.

Example

plugins:
  - strip-number-prefix:
      pattern: '^\d{3}_'

Quote

"Clean URLs make for better documentation" - Every developer

Collapsible Admonitions¶

Click to expand

This content is hidden by default!

Expanded by default

This content is visible by default but can be collapsed.