Add GitHub style alerts / admonitions #519
Merged
Conversation
This file contains 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
Run on Fri Jan 17 01:36:04 UTC 2025 |
Also allows overriding the title by specifying a string after the alert syntax.
digitalmoksha
force-pushed
the
bw-admonmition-blocks
branch
from
612eb62 to
8686e9e
Compare
|
This is fully working. Just need to
|
kivikakk
approved these changes
Jan 19, 2025
Co-authored-by: Talya Connor <[email protected]>
|
I did run fuzzing with |
mfontanini
added a commit
to mfontanini/presenterm
that referenced
this pull request
Jan 23, 2025
This adds supports for markdown alerts (github/gitlab style) as support for these was recently added to comrak. This for now looks close a block quote except it also contains a title colored the same color as the vertical bar prefix that shows up on the left of the block quote. See kivikakk/comrak#519 and kivikakk/comrak#521 for syntax but basically this: ```markdown > [!note] > this is a note > [!tip] > this is a tip > [!important] > this is important > [!warning] > this is warning! > [!caution] > this advises caution! >>> [!note] other title ez multiline >>> ``` Renders like this: 
|
Just wanted to express my appreciation for this feature! Sometimes open source is awesome: I just bump my comrak version (+enable the option) and suddenly I have support for this feature! |
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.
This adds support for GitHub style alerts, such as
Note
Coming very soon
All the types are supported,
NOTE,TIP,IMPORTANT,WARNING, andCAUTIONA couple enhancements have been made:
you can use them anywhere a blockquote can be used, such as in a list item. So this will work:
you can override the title that's displayed by putting text after the trigger. For example:
Instead of showing "Note" as the title, it will show "Exciting news!"
Related to #472