-
-
Notifications
You must be signed in to change notification settings - Fork 8.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix(theme): make warning a first-class admonition, and deprecate caution admonition #9308
Conversation
✅ [V2]
To edit notification comments on pull requests, go to your Netlify site configuration. |
⚡️ Lighthouse report for the deploy preview of this PR
|
Size Change: 0 B Total Size: 1.11 MB ℹ️ View Unchanged
|
Can we emit a warning server-side (and/or in dev mode) each time a deprecated type is used? |
Yes but I'll do that later as I don't want users to be overwhelmed by the v3.0 upgrade immediately |
Fair enough. We can emit warnings later |
1 similar comment
Fair enough. We can emit warnings later |
Would you guys consider keeping both in v4? Both warning and caution have their place in writing, especially in some industries. There are plenty of discussions online explaining what the difference is between them. |
Breaking change
:::warning
admonition becomes yellow instead of red, like most users expect:::warning
is now a first-class official admonition keyword:::caution
is deprecated in v3 and will be removed in v4Motivation
Fix #7558
:::warning
should render as:Instead of:
Note
:::warning
used to be a legacy admonition alias that we didn't even document in the very first v2.0.0 (see docs).Now
:::warning
becomes a first-class official admonition keyword.It replaces the
:::caution
admonition keyword that keeps working in v3 but will be removed in v4 as part of #9307Test Plan
Preview
Test links
https://deploy-preview-9308--docusaurus-2.netlify.app/tests/docs/tests/admonitions