Docs feedback - feature proposal: markdown-it-admonition

Problem to be solved

It would be interesting to add some additional markdown-it functions, such as markdown-it-admonition.

Planned users

All people using README or TODO files (for example), therefore, developers in general.

  • Parker (Product Manager)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#parker-product-manager)
  • Delaney (development team leader)] (https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#delaney-development-team-lead) *Sasha (Software Developer) *Presley (Product Designer) *Devon (DevOps Engineer) *[Sidney (system administrator)] (https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#sidney-systems-administrator) *Sam (security analyst) *[Dana (data analyst)] (https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#dana-data-analyst)

The characters are described at https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/ -->>>

More details

The advantage of markdown-it-admonition is that we can add some details, some warnings, with very visual logos and color codes. The documents are much clearer as well (a bit like with Doxygen).

Proposal

Include the nodejs markdown-it-admonition library.

Permissions and security

No permission is required because it is simply a markdown parser.

Documentation

TBD

Testing

The syntax is designed not to conflict with the rest of the markdown syntax, so there is no risk of conflict.

What does success look like, and how can we measure it?

??

What is the type of buyer?

This feature should be available to all in the CE version.

Links / references

markdown-it-admonition

Edited Jul 07, 2025 by 🤖 GitLab Bot 🤖
Assignee Loading
Time tracking Loading