From bcbe24224c9c8ad4f84edf70f4cfebd89c775fd3 Mon Sep 17 00:00:00 2001 From: squidfunk Date: Wed, 26 May 2021 17:03:49 +0200 Subject: [PATCH] Deprecated seealso admonition qualifier --- docs/reference/admonitions.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/reference/admonitions.md b/docs/reference/admonitions.md index 32bb0d608..239cc43cd 100644 --- a/docs/reference/admonitions.md +++ b/docs/reference/admonitions.md @@ -288,7 +288,7 @@ will stretch to the full width of the viewport, e.g. on mobile viewports. 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`: -`note`{ #note }, `seealso` +`note`{ #note }, ~~`seealso`~~ [^1] : !!! note @@ -384,6 +384,13 @@ 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. + [^1]: + The `seealso` qualifier was originally adapted from the `readthedocs` theme, + in order to make it easier for authors to migrate to Material for MkDocs. + However, when the title is omitted, the admonition extension will render it + as `Seealso`, which is incorrect English. For this reason, it was deprecated + as of 7.1.5 and will be removed in 8.x. + ### Changing the icons [:octicons-file-code-24: Source][13] ยท