feat: use GitHub's markdown alerts for warnings in README #883
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.
Relatively recently GitHub has added support for adding a "callout" element in markdown files (source). I was reading the README and thought it could be something the project might be interested in using, since it has a couple of warnings in the README.
Instead of
it is shown like
Warning
Critical content demanding immediate user attention due to potential risks.
which in my opinion stands out more, which is why I thought you might find it interesting.
This is achieved with the following markdown