To add initial support for github md alerts #496
Conversation
|
We're currently relicensing to Apache 2.0 only (before it was CommonsClause). Could you mention that you're okay with this being licensed under Apache 2.0? |
|
@mrueg I am already a contributor and I have confirmed that I am ok with the lic change |
There was a problem hiding this comment.
Looks good, thanks for the contribution!
I added a few minor nits and one ask: Can you also include it in the README.md under https://github.com/kovetskiy/mark?tab=readme-ov-file#block-quotes that it now supports Github Markdown Alerts?
pkg/mark/renderer/blockquote.go
Outdated
| notePattern := regexp.MustCompile(`note|Note|NOTE`) | ||
| warnPattern := regexp.MustCompile(`warn|Warn|WARN`) | ||
| infoPattern := regexp.MustCompile(`(?i)info|important|caution`) | ||
| notePattern := regexp.MustCompile(`(?i)note`) |
There was a problem hiding this comment.
Looking at the graphics in
https://confluence.atlassian.com/conf59/info-tip-note-and-warning-macros-792499127.html
and
https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts
should we move caution to this one?
There was a problem hiding this comment.
You mean moving caution to be together with warning ?
There was a problem hiding this comment.
Just looking at the symbols and colour schemes, I think this mapping is the best to support Github Alerts:
| Github | Confluence |
|---|---|
| Note (blue I in circle) | Info (blue I in circle) |
| Tip (green lightbulb) | Tip (green checkmark in circle) |
| Important (purple exclamation mark in speech bubble | Info (blue I in circle) |
| Warning (yellow exclamation mark in triangle) | Note (yellow exclamation mark in triangle) |
| Caution (red exclamation mark in hexagon) | Warning (red exclamation mark in hexagon) |
There was a problem hiding this comment.
Please review again after the last commit if it is matching your expectations :)
README.md
Outdated
| @@ -262,7 +262,7 @@ some long code block | |||
| Block Quotes are converted to Confluence Info/Warn/Note box when the following conditions are met | |||
|
|
|||
| 1. The BlockQuote is on the root level of the document (not nested) | |||
| 1. The first line of the BlockQuote contains one of the following patterns `Info/Warn/Note` | |||
| 1. The first line of the BlockQuote contains one of the following patterns `Info/Warn/Note` or [Github MD Alerts 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) `[!INFO]/[!NOTE]/[!WARN][!IMPORTANT]` | |||
There was a problem hiding this comment.
| 1. The first line of the BlockQuote contains one of the following patterns `Info/Warn/Note` or [Github MD Alerts 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) `[!INFO]/[!NOTE]/[!WARN][!IMPORTANT]` | |
| 1. The first line of the BlockQuote contains one of the following patterns `Info/Warn/Note` or [Github MD Alerts 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) `[!NOTE]/[!TIP]/[!IMPORTANT]/[!WARNING]/[!CAUTION]` |
There was a problem hiding this comment.
Can you also include this suggestion?
pkg/mark/renderer/blockquote.go
Outdated
| patternMap: map[string]*regexp.Regexp{ | ||
| "info": regexp.MustCompile(`(?i)^\!info|important`), | ||
| "note": regexp.MustCompile(`(?i)^\!note`), | ||
| "warn": regexp.MustCompile(`(?i)^\!warning|caution`), |
There was a problem hiding this comment.
| "warn": regexp.MustCompile(`(?i)^\!warning|caution`), | |
| "warn": regexp.MustCompile(`(?i)^\!(warning|caution)`), |
|
Thanks for the contribution! |
|
@mrueg please check before squashing |
|
Thanks, those changes look good! |
|
Thanks a lot! |
Closes #494