Feature Request: Expand Admonition Support in GitHub Flavored Markdown

[Po2432]

Product Feedback

GitHub Flavored Markdown (GFM) currently supports a limited set of admonition types like > [!NOTE], > [!TIP], and > [!WARNING]. These are incredibly useful for documentation, READMEs, and wikis — but there's so much more potential.

I’d love to see GitHub expand its native support for additional admonition types and customization options, similar to what tools like Obsidian, Docusaurus, and MkDocs offer.

Admonitions help readers quickly identify the purpose and tone of a block of content. They improve readability, reduce cognitive load, and make documentation more engaging.

Currently, GitHub lacks support for:

> [!QUESTION] – for prompting thought or discussion
> [!EXAMPLE] – to showcase code or use cases
> [!SPOILER] – for collapsible or hidden content
> [!INFO], > [!ABSTRACT], > [!SUCCESS], > [!FAILURE], etc.

These are already widely used in other Markdown ecosystems and would be a natural fit for GitHub’s documentation and community content.

Support for More Admonition Types
Add built-in rendering for additional types like QUESTION, EXAMPLE, SPOILER, INFO, SUCCESS, FAILURE, etc.

Custom Admonition Types
Allow users to define their own types with custom icons and colors.

Collapsible Admonitions
Enable SPOILER or DETAILS blocks that can be expanded/collapsed, useful for hiding long explanations or answers.

Theming and Styling Options
Let users choose between light/dark themes or customize the appearance of admonitions in their repositories.

If you’d love to see GitHub support more expressive and customisable admonitions, upvote this post and share your thoughts below. Let’s make Markdown on GitHub even more powerful for writers, developers, and educators alike.

[github-actions[bot]]

💬 Your Product Feedback Has Been Submitted 🎉

Thank you for taking the time to share your insights with us! Your feedback is invaluable as we build a better GitHub experience for all our users.

Here's what you can expect moving forward ⏩

• Your input will be carefully reviewed and cataloged by members of our product teams. 
  • Due to the high volume of submissions, we may not always be able to provide individual responses.
  • Rest assured, your feedback will help chart our course for product improvements.
• Other users may engage with your post, sharing their own perspectives or experiences. 
• GitHub staff may reach out for further clarification or insight. 
  • We may 'Answer' your discussion if there is a current solution, workaround, or roadmap/changelog post related to the feedback.

Where to look to see what's shipping 👀

• Read the Changelog for real-time updates on the latest GitHub features, enhancements, and calls for feedback.
• Explore our Product Roadmap, which details upcoming major releases and initiatives.

What you can do in the meantime 💻

• Upvote and comment on other user feedback Discussions that resonate with you.
• Add more information at any point! Useful details include: use cases, relevant labels, desired outcomes, and any accompanying screenshots.

As a member of the GitHub community, your participation is essential. While we can't promise that every suggestion will be implemented, we want to emphasize that your feedback is instrumental in guiding our decisions and priorities.

Thank you once again for your contribution to making GitHub even better! We're grateful for your ongoing support and collaboration in shaping the future of our platform. ⭐