Skip to content

Commit bcbe242

Browse files
committed
Deprecated seealso admonition qualifier
1 parent a20dc50 commit bcbe242

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

docs/reference/admonitions.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,7 @@ will stretch to the full width of the viewport, e.g. on mobile viewports.
288288
Following is a list of type qualifiers provided by Material for MkDocs, whereas
289289
the default type, and thus fallback for unknown type qualifiers, is `note`:
290290

291-
`note`{ #note }, `seealso`
291+
`note`{ #note }, ~~`seealso`~~ [^1]
292292

293293
: !!! note
294294

@@ -384,6 +384,13 @@ the default type, and thus fallback for unknown type qualifiers, is `note`:
384384
euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo
385385
purus auctor massa, nec semper lorem quam in massa.
386386

387+
[^1]:
388+
The `seealso` qualifier was originally adapted from the `readthedocs` theme,
389+
in order to make it easier for authors to migrate to Material for MkDocs.
390+
However, when the title is omitted, the admonition extension will render it
391+
as `Seealso`, which is incorrect English. For this reason, it was deprecated
392+
as of 7.1.5 and will be removed in 8.x.
393+
387394
### Changing the icons
388395

389396
[:octicons-file-code-24: Source][13] ·

0 commit comments

Comments
 (0)