Support for GitHub-Flavored Markdown Alerts (e.g., > [!NOTE]) in GitHub Pages

[aqib-m31]

Select Topic Area

General

Body

I would like to request support for rendering GitHub-Flavored Markdown (GFM) alerts, such as > [!NOTE] and similar syntax, when deploying repositories via GitHub Pages.

Context:
When deploying a repository through GitHub Pages, the README.md file is rendered as the default webpage if no index.html is present. However, some advanced Markdown features supported on GitHub, such as [!NOTE] alerts (used to highlight important notes), are not rendered correctly on GitHub Pages. Instead, the syntax appears as plain text on the deployed page.

Example:

> [!NOTE]
> This is a highlighted note using GitHub-Flavored Markdown.

• On GitHub: This renders as a styled note.
• On GitHub Pages: This appears as > [!NOTE] This is a highlighted note..., without any special formatting.

Request:
It would be great if GitHub Pages could support these commonly used alert blocks natively, just like they are rendered on GitHub repositories. This feature would greatly improve the consistency of content presentation between repositories and GitHub Pages.

Why this matters:
Many users rely on GitHub Pages to host project documentation. Ensuring that advanced Markdown features render properly will enhance the quality and readability of the hosted content without requiring users to rely on custom HTML or additional styling.

[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. ⭐

[DilemmaGX]

Check out my Moska repo, it works for pages.

[frozenfrank]

Would a resolution to this issue also allow Mermaid diagrams to render properly on GitHub pages? That would be a huge plus!