Skip to content

Alerts section in Markdown page contains invalid sample alert, and is missing alert type #36265

@chalin

Description

@chalin

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs#alerts

What part(s) of the article would you like to see updated?

There are two issues with the Alerts section of https://docs.github.com/en/contributing/writing-for-github-docs/using-markdown-and-liquid-in-github-docs#alerts:

  1. The given one-line alert example:

    > [!NOTE] Keep this in mind.

    doesn't render / isn't supported as you can see next:

    [!NOTE] Keep this in mind.

  2. The list of types is missing Important, as was noted and fixed elsewhere:

    It is probably best to keep things DRY and refer readers to the style guide.

Additional information

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    contentThis issue or pull request belongs to the Docs Content team

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions