feat: adding support for gfm alerts #249
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
SeanCassiere
commented
Jul 8, 2024
There was a problem hiding this comment.
It pretty much matches what's being done by Github with the exception of;
- Adding opacity to the border - This is to match what we currently have going on the website for blockquotes.
- Adding a background to alert in dark mode - This is to make the alert content stand out more on the page.
|
|
||
| /* Markdown Alerts */ | ||
| .markdown-alert { | ||
| @apply border-l-4 pl-4 py-1.5 my-2 dark:bg-gray-900 rounded-r-sm; |
There was a problem hiding this comment.
The background on when in dark mode is not something Github does. I chose to add it in so it better stood out on the page since our page's dark background makes it all blend in like regular page content.
SeanCassiere
changed the title
tobySolutions
approved these changes
Jul 9, 2024
KevinVandy
approved these changes
Jul 9, 2024
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.
Adding UI support for GFM Alerts.
These GFM Alert types are supported. Below is the output of Github's Alerts.
Note
Highlights information that users should take into account, even when skimming.
Tip
Highlights information that users should take into account, even when skimming.
Important
Highlights information that users should take into account, even when skimming.
Warning
Highlights information that users should take into account, even when skimming.
Caution
Highlights information that users should take into account, even when skimming.
This is the input required to insert a GFM Alert. The options are
NOTE,TIP,IMPORTANT,WARNING, andCAUTION.This is what it'd look like on the docs pages.