OpenSourceArk/mkdocs-material
1
0
Fork 0
mirror of https://github.com/squidfunk/mkdocs-material.git synced 2024-06-14 11:52:32 +03:00
Code Issues Packages Projects Releases Wiki Activity

Deprecated additional admonition qualifiers

Browse Source
This commit is contained in:
squidfunk 2022-10-03 09:58:43 +02:00
parent 69be4f1dca
commit e40c5adf28
1 changed files with 18 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
docs/reference/admonitions.md
View File

@ -288,7 +288,15 @@ will stretch to the full width of the viewport, e.g. on mobile viewports.
### Supported types ### Supported types
Following is a list of type qualifiers provided by Material for MkDocs, whereas Following is a list of type qualifiers provided by Material for MkDocs, whereas
the default type, and thus fallback for unknown type qualifiers, is `note`: the default type, and thus fallback for unknown type qualifiers, is `note`[^1]:
[^1]:
Previously, some of the supported types defined more than one qualifier.
For example, authors could use `summary` or `tldr` as alternative qualifiers
to render an [`abstract`](#type:abstract) admonition. As this increased the
size of the CSS that is shipped with Material for MkDocs, the additional
type qualifiers are now all deprecated and will be removed in the next major
version. This will also be mentioned in the upgrade guide.
[`note`](#type:note){ #type:note } [`note`](#type:note){ #type:note }
@ -298,7 +306,7 @@ the default type, and thus fallback for unknown type qualifiers, is `note`:
euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo
purus auctor massa, nec semper lorem quam in massa. purus auctor massa, nec semper lorem quam in massa.
[`abstract`](#type:abstract){ #type:abstract }, `summary`, `tldr` [`abstract`](#type:abstract){ #type:abstract }
: !!! abstract : !!! abstract
@ -306,7 +314,7 @@ the default type, and thus fallback for unknown type qualifiers, is `note`:
euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo
purus auctor massa, nec semper lorem quam in massa. purus auctor massa, nec semper lorem quam in massa.
[`info`](#type:info){ #type:info }, `todo` [`info`](#type:info){ #type:info }
: !!! info : !!! info
@ -314,7 +322,7 @@ the default type, and thus fallback for unknown type qualifiers, is `note`:
euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo
purus auctor massa, nec semper lorem quam in massa. purus auctor massa, nec semper lorem quam in massa.
[`tip`](#type:tip){ #type:tip }, `hint`, `important` [`tip`](#type:tip){ #type:tip }
: !!! tip : !!! tip
@ -322,7 +330,7 @@ the default type, and thus fallback for unknown type qualifiers, is `note`:
euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo
purus auctor massa, nec semper lorem quam in massa. purus auctor massa, nec semper lorem quam in massa.
[`success`](#type:success){ #type:success }, `check`, `done` [`success`](#type:success){ #type:success }
: !!! success : !!! success
@ -330,7 +338,7 @@ the default type, and thus fallback for unknown type qualifiers, is `note`:
euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo
purus auctor massa, nec semper lorem quam in massa. purus auctor massa, nec semper lorem quam in massa.
[`question`](#type:question){ #type:question }, `help`, `faq` [`question`](#type:question){ #type:question }
: !!! question : !!! question
@ -338,7 +346,7 @@ the default type, and thus fallback for unknown type qualifiers, is `note`:
euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo
purus auctor massa, nec semper lorem quam in massa. purus auctor massa, nec semper lorem quam in massa.
[`warning`](#type:warning){ #type:warning }, `caution`, `attention` [`warning`](#type:warning){ #type:warning }
: !!! warning : !!! warning
@ -346,7 +354,7 @@ the default type, and thus fallback for unknown type qualifiers, is `note`:
euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo
purus auctor massa, nec semper lorem quam in massa. purus auctor massa, nec semper lorem quam in massa.
[`failure`](#type:failure){ #type:failure }, `fail`, `missing` [`failure`](#type:failure){ #type:failure }
: !!! failure : !!! failure
@ -354,7 +362,7 @@ the default type, and thus fallback for unknown type qualifiers, is `note`:
euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo
purus auctor massa, nec semper lorem quam in massa. purus auctor massa, nec semper lorem quam in massa.
[`danger`](#type:danger){ #type:danger }, `error` [`danger`](#type:danger){ #type:danger }
: !!! danger : !!! danger
@ -378,7 +386,7 @@ the default type, and thus fallback for unknown type qualifiers, is `note`:
euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo
purus auctor massa, nec semper lorem quam in massa. purus auctor massa, nec semper lorem quam in massa.
[`quote`](#type:quote){ #type:quote }, `cite` [`quote`](#type:quote){ #type:quote }
: !!! quote : !!! quote