Add Example callout and stylized Terminal block for writing user docs #41
+42
−0
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
This adds two helpers I was tinkering with while writing user docs. The first is an "example" callout that stylizes a block of text for adding examples of how to do something. The second is a stylized Terminal block that's a bit more friendly than trying to triple backtick everything. I was especially annoyed by this because I like angle brackets <> for denoting when users would have to provide their own input, and those are colored incorrectly when you do triple backticks with bash formatting.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This adds two helpers I was tinkering with while writing user docs. The first is an "example" callout that stylizes a block of text for adding examples of how to do something.
The second is a stylized Terminal block that's a bit more friendly than trying to triple backtick everything. I was especially annoyed by this because I like angle brackets <> for denoting when users would have to provide their own input, and those are colored incorrectly when you do triple backticks with bash formatting.