search

hunyadi / md2conf

Publish Markdown files to Confluence wiki
MIT License
56 stars 31 forks source link

Support Gitlab alert box markdown #56

Closed adongy closed 2 months ago

adongy commented 2 months ago

Hello,

Recently support for Github flavored markdown alert boxes was added.

Gitlab has its own version of it, so I'd like to request to add their regexes too, however I understand this is opening a new can of worms of whether both Github and Gitlab features should be added or not.

https://docs.gitlab.com/ee/development/documentation/styleguide/#alert-boxes

Thanks.

hunyadi commented 2 months ago

GitLab documentation writes:

To display an alert box for multiple paragraphs, lists, or headings, use blockquotes instead.

Would you be OK with implementing alert boxes with block-quotes? This would keep the Markdown syntax for GitHub and GitLab similar, with additional keywords FLAG, DISCLAIMER and DETAILS recognized in GitLab but not GitHub. I am somewhat more hesitant to adopt the syntax without block-quotes because there is increased risk of accidentally parsing something into an alert box that is not meant to be. (This is especially true unless we introduce flags for Markdown style, e.g. --github or --gitlab).

Unfortunately, I don't have access to GitLab, and cannot test in this environment. I tried to look for samples how to use alert boxes with the block-quote syntax but didn't find specific examples. Can you share a few? Thanks in advance!

hunyadi commented 2 months ago

FLAG:, NOTE:, WARNING: and DISCLAIMER: are now recognized as prefixes in blockquote text that indicate a GitLab alert box, and are transformed into a Confluence structured macros info, tip, note, or warning.