Feature Request: support for admonitions
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 25.9k
- Forks
- 2.4k
- Avg merge
- 13h 10m
- Merged PRs (30d)
- 4
Description
Would love to see support for admonitions (e.g. like the ones that are supported in the Redocly Developer Portal) here in Redoc. IMO, these are very helpful (if used sparingly 😝 ) in directing developers to important documentation and do a better job than simply bolding text.
In the meantime, I'm using unicode emojis and a markdown blockquote to achieve a similar effect (as suggested in this SO post), but they could look much better!
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
Start by reviewing the linked Redocly Developer Portal admonitions example and comparing it with Redoc's current documentation rendering. Define the supported admonition syntax and visual behavior, then confirm that admonitions render correctly in generated API documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100