Skip to content

An option to highlight a "Note" and "Warning" using blockquote Β #2275

Open
@thomas-k-cameron

Description

@thomas-k-cameron

Problem

Github has recently announced that they are supporting highlight feature on their markdown.

I thought it would be nice if mdbook can support that out of the box.
https://github.com/orgs/community/discussions/16925

Proposed Solution

e.g.

> [!NOTE]  
> Highlights information that users should take into account, even when skimming.

> [!TIP]
> Optional information to help a user be more successful.

> [!IMPORTANT]  
> Crucial information necessary for users to succeed.

> [!WARNING]  
> Critical content demanding immediate user attention due to potential risks.

> [!CAUTION]
> Negative potential consequences of an action.

Note

Highlights information that users should take into account, even when skimming.

Tip

Optional information to help a user be more successful.

Important

Crucial information necessary for users to succeed.

Warning

Critical content demanding immediate user attention due to potential risks.

Caution

Negative potential consequences of an action.

Notes

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-MarkdownArea: Issues with markdownC-enhancementCategory: Enhancement or feature request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions