Throw an error on an invalid Admonition type #284
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
e56e48a to
3492c2a
Compare
|
Amplify deployment status
|
3492c2a to
d978ceb
Compare
The default Docusaurus behavior when rendering an Admonition is to print a warning on an invalid type. This not only causes an unintended result to render on the docs site, it creates clutter when reading docs build output. Since Docusaurus build logs are not structured consistently, it is important to keep it clean for a human reader.
d978ceb to
7a6a94d
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The default Docusaurus behavior when rendering an Admonition is to print a warning on an invalid type. This not only causes an unintended result to render on the docs site, it creates clutter when reading docs build output. Since Docusaurus build logs are not structured consistently, it is important to keep it clean for a human reader.