Skip to content

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

Description

@jonrkarr

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

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions