Restrict only to GitHub callout keywords

oprypin · Dec 19, 2023 · 71311e7 · 71311e7
1 parent a679a9f
commit 71311e7
Show file tree

Hide file tree

Showing 4 changed files with 81 additions and 5 deletions.
diff --git a/markdown_callouts/github_callouts.py b/markdown_callouts/github_callouts.py
@@ -11,7 +11,7 @@
 # Based on https://github.com/Python-Markdown/markdown/blob/4acb949256adc535d6e6cd84c4fb47db8dda2f46/markdown/blockprocessors.py#L277
 class _GitHubCalloutsBlockProcessor(BlockQuoteProcessor):
     REGEX = re.compile(
-        r"((?:^|\n) *(?:[^>].*)?(?:^|\n)) {0,3}> *\[!([A-Za-z]{3,})\] *\n(?: *> *\n)*() *(?:> *[^\s\n]|[^\s\n>])"
+        r"((?:^|\n) *(?:[^>].*)?(?:^|\n)) {0,3}> *\[!(NOTE|TIP|IMPORTANT|WARNING|CAUTION)\] *\n(?: *> *\n)*() *(?:> *[^\s\n]|[^\s\n>])",flags=re.IGNORECASE
     )
 
     def test(self, parent, block):
@@ -31,7 +31,10 @@ def run(self, parent: etree.Element, blocks: list[str]) -> None:
         self.parser.parseBlocks(parent, [before])
         kind = m[2]
 
-        admon = etree.SubElement(parent, "div", {"class": "admonition " + kind.lower()})
+        css_class = kind.lower()
+        if css_class == 'caution':
+            css_class = 'danger'
+        admon = etree.SubElement(parent, "div", {"class": "admonition " + css_class})
         title = etree.SubElement(admon, "p", {"class": "admonition-title"})
         title.text = kind.title()
 

diff --git a/tests/github/classes-nope.yml b/tests/github/classes-nope.yml
@@ -0,0 +1,17 @@
+input: |
+  > [!INFO]
+  > foo
+
+  > [!TIPSY]
+  > foo
+output: |-
+  <blockquote>
+    <p>
+      [!INFO]
+  foo
+    </p>
+    <p>
+      [!TIPSY]
+  foo
+    </p>
+  </blockquote>
diff --git a/tests/github/classes.yml b/tests/github/classes.yml
@@ -0,0 +1,56 @@
+input: |
+  > [!NOTE]
+  > foo
+
+  > [!TIP]
+  > foo
+
+  > [!IMPORTANT]
+  > foo
+
+  > [!WARNING]
+  > foo
+
+  > [!CAUTION]
+  > foo
+output: |-
+  <div class="admonition note">
+    <p class="admonition-title">
+      Note
+    </p>
+    <p>
+      foo
+    </p>
+  </div>
+  <div class="admonition tip">
+    <p class="admonition-title">
+      Tip
+    </p>
+    <p>
+      foo
+    </p>
+  </div>
+  <div class="admonition important">
+    <p class="admonition-title">
+      Important
+    </p>
+    <p>
+      foo
+    </p>
+  </div>
+  <div class="admonition warning">
+    <p class="admonition-title">
+      Warning
+    </p>
+    <p>
+      foo
+    </p>
+  </div>
+  <div class="admonition danger">
+    <p class="admonition-title">
+      Caution
+    </p>
+    <p>
+      foo
+    </p>
+  </div>
diff --git a/tests/github/varied-case.yml b/tests/github/varied-case.yml
@@ -1,5 +1,5 @@
 input: |
-  > [!info]
+  > [!important]
   > Foo
 
   > [!TIP]
@@ -8,9 +8,9 @@ input: |
   > [!NoTe]
   > Foo
 output: |-
-  <div class="admonition info">
+  <div class="admonition important">
     <p class="admonition-title">
-      Info
+      Important
     </p>
     <p>
       Foo