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

[Feature Request] Admonitions / Callouts #74

Open
kiryph opened this issue Jul 19, 2024 · 0 comments
Open

[Feature Request] Admonitions / Callouts #74

kiryph opened this issue Jul 19, 2024 · 0 comments

Comments

@kiryph
Copy link

kiryph commented Jul 19, 2024

Many documentation systems have introduced special text blocks to draw the readers attention to critical information, called sometimes alerts, admonitions or callouts.

Examples:

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.

Can something similar be added to GAPDoc?

kiryph added a commit to kiryph/GAPDoc that referenced this issue Oct 24, 2024
kiryph added a commit to kiryph/GAPDoc that referenced this issue Oct 24, 2024
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