Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(markdown): Add tip, caution and important notecard types #11050

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

queengooborg
Copy link
Collaborator

Summary

This PR is a follow-up to #10168 that adds support for three notecard types introduced by the GFM noteblocks proposal that Yari does not currently support: tip, important and caution.

Copyright notice: new icons for these types have been created by splicing together elements from existing icons. The light bulb for the new tip icon was created in-house by a vector artist from my company, Gooborg Studios.


Screenshots

Before

image

After

image

How did you test this change?

Markdown used:

## MDN Style

> **Note:** Note!

> **Tip:** A helpful tip

> **Important:** Something important

> **Warning:** Be weary of this!

> **Caution:** Don't set this thing!

> **Callout:** Some call to action!

---

## GFM Proposal Style

> [!NOTE]
> Note!

> [!TIP]
> A helpful tip

> [!IMPORTANT]
> Something important

> [!WARNING]
> Be weary of this!

> [!CAUTION]
> Don't set this thing!

> [!CALLOUT]
> Some call to action!

@queengooborg queengooborg requested a review from a team as a code owner May 2, 2024 22:39
@github-actions github-actions bot added the markdown markdown related issues and pull requests label May 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
markdown markdown related issues and pull requests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant