dotnet / dotnet/docfx

[Feature Request] Support alert styles that compatible to `learn.microsoft.com`

Open
#9,731 4 comments 5 reactions 0 assignees View on GitHub
markdown
Dominant language
C#
Stars
4.4k
Forks
890
Avg merge
2h 11m
Merged PRs (30d)
10

Description

**Is your feature request related to a problem? Please describe.**

Currently docfx supports [Alerts](https://dotnet.github.io/docfx/docs/markdown.html?tabs=linux%2Cdotnet#alerts) by using [Bootstrap's alert styles](https://getbootstrap.com/docs/5.3/components/alerts/#examples)

Recently GFM(GitHub Flavored Markdown) supports same alert syntax.
But its styles are similar to the styles of `learn.microsoft.com'. And supports more background color variations.
- [GitHub alert style](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts)
- [`learn.microsoft.com` alert style]( https://learn.microsoft.com/en-us/contribute/content/markdown-reference#alerts-note-tip-important-caution-warning])

**Describe the solution you'd like**
Add support for GitHub or `learn.microsoft.com` compatible alert styles.

**Additional context**
These features might be implemented by markdig as custom extensions. (https://github.com/xoofx/markdig/issues/774)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.