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

GitHub Alerts syntax support in Admonition #155

Open
cilerler opened this issue Aug 19, 2023 · 0 comments
Open

GitHub Alerts syntax support in Admonition #155

cilerler opened this issue Aug 19, 2023 · 0 comments

Comments

@cilerler
Copy link

cilerler commented Aug 19, 2023

As a user, I want the application's admonition feature to support GitHub's new "Alert" feature syntax, so I can use the extension to generate GitHub-compatible documents.

Example usage

> [!NOTE]  
> Highlights information that users should take into account, even when skimming.

> [!TIP]
> Optional information to help a user be more successful.

> [!IMPORTANT]  
> Crucial information necessary for users to succeed.

> [!WARNING]  
> Critical content demanding immediate user attention due to potential risks.

> [!CAUTION]
> Negative potential consequences of an action.

Note

Highlights information that users should take into account, even when skimming.

Tip

Optional information to help a user be more successful.

Important

Crucial information necessary for users to succeed.

Warning

Critical content demanding immediate user attention due to potential risks.

Caution

Negative potential consequences of an action.

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

1 participant