Skip to content

Support admonitions / alerts / callouts in markdown #10751

@lukasmasuch

Description

@lukasmasuch

Checklist

  • I have searched the existing issues for similar feature requests.
  • I added a descriptive title and summary to this issue.

Summary

Implement support for alert blocks (aka admonitions) within the Streamlit markdown flavour.

Why?

This is supported by many other markdown flavours as well.

How?

Unfortunately, there isn't one common syntax for this... we probably have to choose between one of these:

Github markdown:

Note

This is a note alert block

> [!NOTE]  
> This is a note alert block

PyMdown:

??? note
   This is a note alert block

Material for Mkdocs & Python Markdown:

!!! note

    This is a note alert block

Docusaurus:

:::note

This is a note alert block

:::

Additional Context

Metadata

Metadata

Assignees

No one assigned

    Labels

    feature:markdownRelated to Markdown renderingtype:enhancementRequests for feature enhancements or new features

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions