3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-08-02 08:19:07 +02:00
Code Issues Projects Releases Packages Wiki Activity

fix(theme): make warning a first-class admonition, and deprecate caution admonition (#9308)

Browse source
This commit is contained in:
Sébastien Lorber 2023-09-15 10:48:21 +02:00 • committed by GitHub
parent 58be496da2
commit f5ae537d3e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
339 changed files with 666 additions and 515 deletions
Download patch file Download diff file Expand all files Collapse all files

2
website/versioned_docs/version-2.1.0/api/misc/create-docusaurus.mdx
View file

@ -24,7 +24,7 @@ The `template` argument can be one of the following:
The `rootDir` will be used to resolve the absolute path to the site directory. The default is CWD.
:::caution
:::warning
This command should be preferably used in an interactive shell so all features are available.

2
website/versioned_docs/version-2.1.0/api/misc/logger/logger.mdx
View file

@ -34,7 +34,7 @@ It exports a single object as default export: `logger`. `logger` has the followi
- `success`: prints a success message.
- The `report` function. It takes a `ReportingSeverity` value (`ignore`, `log`, `warn`, `throw`) and reports a message according to the severity.
:::caution A word on the `error` formatter
:::warning A word on the `error` formatter
Beware that an `error` message, even when it doesn't hang the program, is likely going to cause confusion. When users inspect logs and find an `[ERROR]`, even when the build succeeds, they will assume something is going wrong. Use it sparingly.