Skip to content

Feature idea: admonitions #1378

@giltho

Description

@giltho

I find admonitions to be particularly helpful, particularly for warnings and danger. See for instance this example in the documentation of React where a "Pitfall" admonition warns of common errors.

Something like:

{note ...}
{tip ...}
{warn ...}
{important ...}
{caution ...}

I chose these specific kinds based on what Github has, but it could be others.

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