nextra icon indicating copy to clipboard operation
nextra copied to clipboard

Feedback for “GitHub Alert Syntax”

Open Purp16 opened this issue 1 year ago • 1 comments

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.

Purp16 avatar Jan 08 '25 02:01 Purp16

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

Prettier Playground

dimaMachina avatar Jan 09 '25 18:01 dimaMachina