Use GitHub admonitions for the README callouts#138
Merged
Conversation
Turn the note-in-disguise paragraphs into proper GitHub admonitions so they stand out and match the existing one in the install section: - the project-name aside -> [!NOTE] - the maintainers-wanted call to action -> [!IMPORTANT] - the "assumes the CIDER plugin" heads-up in the usage section -> [!NOTE]
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Turns the note-in-disguise paragraphs into proper GitHub admonitions so they render as real callouts and match the existing one in the install section:
[!NOTE][!IMPORTANT][!NOTE]Docs only.