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

Feedback for “GitHub Alert Syntax” #3900

Open
Purp16 opened this issue Jan 8, 2025 · 1 comment
Open

Feedback for “GitHub Alert Syntax” #3900

Purp16 opened this issue Jan 8, 2025 · 1 comment

Comments

@Purp16
Copy link

Purp16 commented Jan 8, 2025

Viewing the doc of 4.0 and trying out the playground, found that the alert syntax is a bit different from original definition. Specifically an empty line is required, which causes an unnecessary gap between the Line of icon and description.

What appears and should work in nextra:

> [!NOTE]
>
> Useful information that users should know, even when skimming content.
 
> [!TIP]
>
> Helpful advice for doing things better or more easily.
 
> [!IMPORTANT]
>
> Key information users need to know to achieve their goal.
 
> [!WARNING]
>
> Urgent info that needs immediate user attention to avoid problems.
 
> [!CAUTION]
>
> Advises about risks or negative outcomes of certain actions.

Original GitHub Alert Syntax:

> [!NOTE]
> Useful information that users should know, even when skimming content.

> [!TIP]
> Helpful advice for doing things better or more easily.

> [!IMPORTANT]
> Key information users need to know to achieve their goal.

> [!WARNING]
> Urgent info that needs immediate user attention to avoid problems.

> [!CAUTION]
> Advises about risks or negative outcomes of certain actions.
@dimaMachina
Copy link
Collaborator

Hi, this was made because prettier incorrectly wrap next line on first line with alert syntax with proseWrap: 'always' | 'never' setting.

Prettier Playground

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants