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

Blockquote for other message types (admonition) #23

Open
Apostolique opened this issue Apr 22, 2021 · 1 comment
Open

Blockquote for other message types (admonition) #23

Apostolique opened this issue Apr 22, 2021 · 1 comment
Labels
enhancement New feature or request

Comments

@Apostolique
Copy link
Owner

Sometimes it's useful to add some meta information in a page. For example a note, call to action, warning, tip, etc. Each one would require some special styling.

A backward compatible way of doing this would be with a blockquote:

Note: Hello world!

> Note: Hello world!

Some examples can be seen in the vuejs documentation:

image

image

image

@Apostolique Apostolique added the enhancement New feature or request label Apr 22, 2021
@Apostolique
Copy link
Owner Author

GitHub supports this: https://github.com/orgs/community/discussions/16925

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
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant