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.

Sign up for GitHub

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

Jump to bottom

Use admonitions to highlight non-intuitive behaviors that are easily missed #212

Open

jonrkarr opened this issue Feb 16, 2022 · 0 comments

Contributor

jonrkarr commented Feb 16, 2022

Examples

"The Fill of a Style has no meaning and, if present, will be ignored."
"The Marker of a Style has no meaning and, if present, will be ignored."
"... and can be anything"

As an example, here's how mkdocs enables developers to alert readers
https://squidfunk.github.io/mkdocs-material/reference/admonitions/#admonition-icons

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment