mdx-editor / mdx-editor/editor
[Feature] Support GH Flavored Admonition out of the box
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 3.7k
- Forks
- 307
- Avg merge
- 14h 22m
- Merged PRs (30d)
- 5
Description
It would be great if we could have out of the box support for GH flavored Admonitions / Alerts
As a first step, being able to pass the list of allowed admonitions to the AdmonitionDirectiveDescriptor
Ultimatly, adding parsing for GH Flavored Alerts
> [!IMPORTANT]
> This is an important alert.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The named entry point is AdmonitionDirectiveDescriptor; start by tracing how its allowed admonition list is consumed and how markdown block syntax reaches it. Compare the documented GH Alert example with existing admonition behavior, then verify the allowed-list step and eventual parsing behavior in the editor.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown, react, typescript
- Domain
- content, frontend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100