From e40c5adf285fcbaf1709ec6c4696244b234d78fd Mon Sep 17 00:00:00 2001 From: squidfunk Date: Mon, 3 Oct 2022 09:58:43 +0200 Subject: [PATCH] Deprecated additional admonition qualifiers --- docs/reference/admonitions.md | 28 ++++++++++++++++++---------- 1 file changed, 18 insertions(+), 10 deletions(-) diff --git a/docs/reference/admonitions.md b/docs/reference/admonitions.md index 51bc9b75c..15408aef7 100644 --- a/docs/reference/admonitions.md +++ b/docs/reference/admonitions.md @@ -288,7 +288,15 @@ will stretch to the full width of the viewport, e.g. on mobile viewports. ### Supported types 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 } @@ -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 purus auctor massa, nec semper lorem quam in massa. -[`abstract`](#type:abstract){ #type:abstract }, `summary`, `tldr` +[`abstract`](#type:abstract){ #type: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 purus auctor massa, nec semper lorem quam in massa. -[`info`](#type:info){ #type:info }, `todo` +[`info`](#type:info){ #type: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 purus auctor massa, nec semper lorem quam in massa. -[`tip`](#type:tip){ #type:tip }, `hint`, `important` +[`tip`](#type:tip){ #type: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 purus auctor massa, nec semper lorem quam in massa. -[`success`](#type:success){ #type:success }, `check`, `done` +[`success`](#type:success){ #type: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 purus auctor massa, nec semper lorem quam in massa. -[`question`](#type:question){ #type:question }, `help`, `faq` +[`question`](#type:question){ #type: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 purus auctor massa, nec semper lorem quam in massa. -[`warning`](#type:warning){ #type:warning }, `caution`, `attention` +[`warning`](#type:warning){ #type: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 purus auctor massa, nec semper lorem quam in massa. -[`failure`](#type:failure){ #type:failure }, `fail`, `missing` +[`failure`](#type:failure){ #type: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 purus auctor massa, nec semper lorem quam in massa. -[`danger`](#type:danger){ #type:danger }, `error` +[`danger`](#type:danger){ #type: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 purus auctor massa, nec semper lorem quam in massa. -[`quote`](#type:quote){ #type:quote }, `cite` +[`quote`](#type:quote){ #type:quote } : !!! quote