Skip to content

Document new Note renderings > **Note**, > **Warning**, etc. #18164

Closed
@aisgbnok

Description

@aisgbnok

Code of Conduct

What article on docs.github.com is affected?

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

I just noticed that using > **Note** will generate a rendered/highlighted Note with a little info icon.

Note

I use this syntax in some markdown files, and it just started rendering this way. (Update: see community/community#16925 (comment).)

I'm not entirely sure the best location to put this, you can see my suggestions above? If this becomes open to public contribution, I would love to open a PR documenting this. Thanks!

Additional information

I love these new little improvements that are being done across the site, similar to #17312 with color rendering #3fb950, adding LaTeX rendering, and now this new Note rendering.

Note
Yes

Error
No

Warning
Yes

Info
No

Success
No

I'd love to see how these develop and help document them.

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

    contentThis issue or pull request belongs to the Docs Content teamwaiting for reviewIssue/PR is waiting for a writer's review

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions