Implement GitHub-style syntax

oprypin · Dec 18, 2023 · a679a9f · a679a9f
1 parent 8d2b4d1
commit a679a9f
Show file tree

Hide file tree

Showing 62 changed files with 501 additions and 3 deletions.
diff --git a/markdown_callouts/github_callouts.py b/markdown_callouts/github_callouts.py
@@ -0,0 +1,53 @@
+from __future__ import annotations
+
+import re
+import xml.etree.ElementTree as etree
+
+from markdown import Markdown, util
+from markdown.blockprocessors import BlockQuoteProcessor
+from markdown.extensions import Extension
+
+
+# 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>])"
+    )
+
+    def test(self, parent, block):
+        return (
+            bool(self.REGEX.search(block))
+            and not self.parser.state.isstate("blockquote")
+            and not util.nearing_recursion_limit()
+        )
+
+    def run(self, parent: etree.Element, blocks: list[str]) -> None:
+        block = blocks.pop(0)
+        m = self.REGEX.search(block)
+        assert m
+
+        before = block[: m.end(1)]
+        block = "\n".join(self.clean(line) for line in block[m.end(3) :].split("\n"))
+        self.parser.parseBlocks(parent, [before])
+        kind = m[2]
+
+        admon = etree.SubElement(parent, "div", {"class": "admonition " + kind.lower()})
+        title = etree.SubElement(admon, "p", {"class": "admonition-title"})
+        title.text = kind.title()
+
+        self.parser.state.set("blockquote")
+        self.parser.parseChunk(admon, block)
+        self.parser.state.reset()
+
+
+class GitHubCalloutsExtension(Extension):
+    def extendMarkdown(self, md: Markdown) -> None:
+        parser = md.parser  # type: ignore
+        parser.blockprocessors.register(
+            _GitHubCalloutsBlockProcessor(parser),
+            "github-callouts",
+            21.1,  # Right before blockquote
+        )
+
+
+makeExtension = GitHubCalloutsExtension
diff --git a/pyproject.toml b/pyproject.toml
@@ -43,6 +43,7 @@ History = "https://github.com/oprypin/markdown-callouts/releases"
 
 [project.entry-points."markdown.extensions"]
 callouts = "markdown_callouts.callouts:CalloutsExtension"
+github-callouts = "markdown_callouts.github_callouts:GitHubCalloutsExtension"
 
 [tool.hatch.version]
 path = "markdown_callouts/__init__.py"

diff --git a/tests/all/adjacent.yml b/tests/all/adjacent.yml
@@ -0,0 +1,22 @@
+input: |
+  > [!Note]
+  > foo
+
+  NOTE: bar
+output: |-
+  <div class="admonition note">
+    <p class="admonition-title">
+      Note
+    </p>
+    <p>
+      foo
+    </p>
+  </div>
+  <div class="admonition note">
+    <p class="admonition-title">
+      Note
+    </p>
+    <p>
+      bar
+    </p>
+  </div>
diff --git a/tests/extension/adjacent-1.yml → tests/callouts/adjacent-1.yml b/tests/extension/adjacent-1.yml → tests/callouts/adjacent-1.yml
diff --git a/tests/extension/adjacent-2.yml → tests/callouts/adjacent-2.yml b/tests/extension/adjacent-2.yml → tests/callouts/adjacent-2.yml
diff --git a/tests/extension/adjacent-3.yml → tests/callouts/adjacent-3.yml b/tests/extension/adjacent-3.yml → tests/callouts/adjacent-3.yml
diff --git a/tests/extension/adjacent-nope.yml → tests/callouts/adjacent-nope.yml b/tests/extension/adjacent-nope.yml → tests/callouts/adjacent-nope.yml
diff --git a/tests/extension/adjacent-text-block.yml → tests/callouts/adjacent-text-block.yml b/tests/extension/adjacent-text-block.yml → tests/callouts/adjacent-text-block.yml
diff --git a/tests/extension/adjacent-text-nope.yml → tests/callouts/adjacent-text-nope.yml b/tests/extension/adjacent-text-nope.yml → tests/callouts/adjacent-text-nope.yml
diff --git a/tests/extension/basic.yml → tests/callouts/basic.yml b/tests/extension/basic.yml → tests/callouts/basic.yml
diff --git a/tests/extension/blockquotes-many-joined.yml → tests/callouts/blockquotes-many-joined.yml b/tests/extension/blockquotes-many-joined.yml → tests/callouts/blockquotes-many-joined.yml
diff --git a/...tension/blockquotes-split-by-comments.yml → ...allouts/blockquotes-split-by-comments.yml b/...tension/blockquotes-split-by-comments.yml → ...allouts/blockquotes-split-by-comments.yml
diff --git a/tests/extension/blockquotes-together.yml → tests/callouts/blockquotes-together.yml b/tests/extension/blockquotes-together.yml → tests/callouts/blockquotes-together.yml
diff --git a/tests/extension/details/basic-open.yml → tests/callouts/details/basic-open.yml b/tests/extension/details/basic-open.yml → tests/callouts/details/basic-open.yml
diff --git a/tests/extension/details/basic.yml → tests/callouts/details/basic.yml b/tests/extension/details/basic.yml → tests/callouts/details/basic.yml
diff --git a/tests/extension/details/extra-space-nope.yml → tests/callouts/details/extra-space-nope.yml b/tests/extension/details/extra-space-nope.yml → tests/callouts/details/extra-space-nope.yml
diff --git a/tests/extension/details/nested.yml → tests/callouts/details/nested.yml b/tests/extension/details/nested.yml → tests/callouts/details/nested.yml
diff --git a/tests/extension/details/no-space.yml → tests/callouts/details/no-space.yml b/tests/extension/details/no-space.yml → tests/callouts/details/no-space.yml
diff --git a/tests/extension/extra-space.yml → tests/callouts/extra-space.yml b/tests/extension/extra-space.yml → tests/callouts/extra-space.yml
diff --git a/tests/extension/just-callout.yml → tests/callouts/just-callout.yml b/tests/extension/just-callout.yml → tests/callouts/just-callout.yml
diff --git a/tests/extension/linebreak-after.yml → tests/callouts/linebreak-after.yml b/tests/extension/linebreak-after.yml → tests/callouts/linebreak-after.yml
diff --git a/tests/extension/lowercase.yml → tests/callouts/lowercase-nope.yml b/tests/extension/lowercase.yml → tests/callouts/lowercase-nope.yml
diff --git a/tests/extension/nested-block.yml → tests/callouts/nested-block.yml b/tests/extension/nested-block.yml → tests/callouts/nested-block.yml
diff --git a/tests/extension/newline-first.yml → tests/callouts/newline-first.yml b/tests/extension/newline-first.yml → tests/callouts/newline-first.yml
diff --git a/tests/extension/one-letter.yml → tests/callouts/one-letter.yml b/tests/extension/one-letter.yml → tests/callouts/one-letter.yml
diff --git a/...extension/title/avoid-bold-after-text.yml → .../callouts/title/avoid-bold-after-text.yml b/...extension/title/avoid-bold-after-text.yml → .../callouts/title/avoid-bold-after-text.yml
diff --git a/tests/extension/title/avoid-title.yml → tests/callouts/title/avoid-title.yml b/tests/extension/title/avoid-title.yml → tests/callouts/title/avoid-title.yml
diff --git a/tests/extension/title/basic.yml → tests/callouts/title/basic.yml b/tests/extension/title/basic.yml → tests/callouts/title/basic.yml
diff --git a/...xtension/title/blockstyle-interrupted.yml → ...callouts/title/blockstyle-interrupted.yml b/...xtension/title/blockstyle-interrupted.yml → ...callouts/title/blockstyle-interrupted.yml
diff --git a/tests/extension/title/blockstyle.yml → tests/callouts/title/blockstyle.yml b/tests/extension/title/blockstyle.yml → tests/callouts/title/blockstyle.yml
diff --git a/tests/extension/title/inline-formatting.yml → tests/callouts/title/inline-formatting.yml b/tests/extension/title/inline-formatting.yml → tests/callouts/title/inline-formatting.yml
diff --git a/...extension/title/linebreak-after-title.yml → .../callouts/title/linebreak-after-title.yml b/...extension/title/linebreak-after-title.yml → .../callouts/title/linebreak-after-title.yml
diff --git a/tests/extension/title/link-ref-as-title.yml → tests/callouts/title/link-ref-as-title.yml b/tests/extension/title/link-ref-as-title.yml → tests/callouts/title/link-ref-as-title.yml
diff --git a/tests/extension/title/multiline-title.yml → tests/callouts/title/multiline-title.yml b/tests/extension/title/multiline-title.yml → tests/callouts/title/multiline-title.yml
diff --git a/tests/extension/title/nested-block.yml → tests/callouts/title/nested-block.yml b/tests/extension/title/nested-block.yml → tests/callouts/title/nested-block.yml
diff --git a/tests/extension/title/no-body.yml → tests/callouts/title/no-body.yml b/tests/extension/title/no-body.yml → tests/callouts/title/no-body.yml
diff --git a/tests/extension/title/no-dot.yml → tests/callouts/title/no-dot.yml b/tests/extension/title/no-dot.yml → tests/callouts/title/no-dot.yml
diff --git a/tests/extension/title/no-strip-period.yml → tests/callouts/title/no-strip-period.yml b/tests/extension/title/no-strip-period.yml → tests/callouts/title/no-strip-period.yml
diff --git a/...s/extension/title/preserve-dot-double.yml → tests/callouts/title/preserve-dot-double.yml b/...s/extension/title/preserve-dot-double.yml → tests/callouts/title/preserve-dot-double.yml
diff --git a/...s/extension/title/preserve-dot-escape.yml → tests/callouts/title/preserve-dot-escape.yml b/...s/extension/title/preserve-dot-escape.yml → tests/callouts/title/preserve-dot-escape.yml
diff --git a/...s/extension/title/preserve-dot-format.yml → tests/callouts/title/preserve-dot-format.yml b/...s/extension/title/preserve-dot-format.yml → tests/callouts/title/preserve-dot-format.yml
diff --git a/tests/extension/title/text-after.yml → tests/callouts/title/text-after.yml b/tests/extension/title/text-after.yml → tests/callouts/title/text-after.yml
diff --git a/tests/extension/with-list.yml → tests/callouts/with-list.yml b/tests/extension/with-list.yml → tests/callouts/with-list.yml
diff --git a/tests/github/adjacent-nope.yml b/tests/github/adjacent-nope.yml
@@ -0,0 +1,17 @@
+input: |
+  > [!Note]
+  > foo
+  > [!Note]
+  > bar
+
+output: |-
+  <div class="admonition note">
+    <p class="admonition-title">
+      Note
+    </p>
+    <p>
+      foo
+  [!Note]
+  bar
+    </p>
+  </div>
diff --git a/tests/github/adjacent-text-block.yml b/tests/github/adjacent-text-block.yml
@@ -0,0 +1,18 @@
+input: |
+  aaa
+  > [!Note]
+  > bbb
+  ccc
+output: |-
+  <p>
+    aaa
+  </p>
+  <div class="admonition note">
+    <p class="admonition-title">
+      Note
+    </p>
+    <p>
+      bbb
+  ccc
+    </p>
+  </div>
diff --git a/tests/github/adjacent-text-nope.yml b/tests/github/adjacent-text-nope.yml
@@ -0,0 +1,14 @@
+input: |
+  > aaa
+  > [!Note]
+  > bbb
+  > ccc
+output: |-
+  <blockquote>
+    <p>
+      aaa
+  [!Note]
+  bbb
+  ccc
+    </p>
+  </blockquote>
diff --git a/tests/github/adjacent.yml b/tests/github/adjacent.yml
@@ -0,0 +1,23 @@
+input: |
+  > [!Note]
+  > foo
+
+  > [!Note]
+  > bar
+output: |-
+  <div class="admonition note">
+    <p class="admonition-title">
+      Note
+    </p>
+    <p>
+      foo
+    </p>
+  </div>
+  <div class="admonition note">
+    <p class="admonition-title">
+      Note
+    </p>
+    <p>
+      bar
+    </p>
+  </div>
diff --git a/tests/github/barely-callout.yml b/tests/github/barely-callout.yml
@@ -0,0 +1,25 @@
+input: |
+  > [!Warning]
+  a
+
+  <!-- -->
+
+  > [!Warning]
+  >>
+output: |-
+  <div class="admonition warning">
+    <p class="admonition-title">
+      Warning
+    </p>
+    <p>
+      a
+    </p>
+  </div>
+  <!-- -->
+  <div class="admonition warning">
+    <p class="admonition-title">
+      Warning
+    </p>
+    <blockquote>
+    </blockquote>
+  </div>
diff --git a/tests/github/basic.yml b/tests/github/basic.yml
@@ -0,0 +1,12 @@
+input: |
+  > [!Note]
+  > Hello, world!
+output: |-
+  <div class="admonition note">
+    <p class="admonition-title">
+      Note
+    </p>
+    <p>
+      Hello, world!
+    </p>
+  </div>
diff --git a/tests/github/blockquotes-many-joined.yml b/tests/github/blockquotes-many-joined.yml
@@ -0,0 +1,32 @@
+input: |
+  > [!Note]
+  > Foo.
+
+  > a
+  > Bar.
+
+  > [!Warning]
+  > Baz.
+output: |-
+  <div class="admonition note">
+    <p class="admonition-title">
+      Note
+    </p>
+    <p>
+      Foo.
+    </p>
+  </div>
+  <blockquote>
+    <p>
+      a
+  Bar.
+    </p>
+  </blockquote>
+  <div class="admonition warning">
+    <p class="admonition-title">
+      Warning
+    </p>
+    <p>
+      Baz.
+    </p>
+  </div>
diff --git a/tests/github/blockquotes-split-by-comments.yml b/tests/github/blockquotes-split-by-comments.yml
@@ -0,0 +1,34 @@
+input: |
+  > [!Note]
+  > Foo.
+  <!-- -->
+  > a
+  > Bar.
+  <!-- -->
+  > [!Warning]
+  > Baz.
+output: |-
+  <div class="admonition note">
+    <p class="admonition-title">
+      Note
+    </p>
+    <p>
+      Foo.
+    </p>
+  </div>
+  <!-- -->
+  <blockquote>
+    <p>
+      a
+  Bar.
+    </p>
+  </blockquote>
+  <!-- -->
+  <div class="admonition warning">
+    <p class="admonition-title">
+      Warning
+    </p>
+    <p>
+      Baz.
+    </p>
+  </div>
diff --git a/tests/github/blockquotes-together.yml b/tests/github/blockquotes-together.yml
@@ -0,0 +1,26 @@
+input: |
+  > [!Note]
+  > Foo.
+  >
+  > a
+  > Bar.
+  >
+  > [!Warning]
+  > Baz.
+output: |-
+  <div class="admonition note">
+    <p class="admonition-title">
+      Note
+    </p>
+    <p>
+      Foo.
+    </p>
+    <p>
+      a
+  Bar.
+    </p>
+    <p>
+      [!Warning]
+  Baz.
+    </p>
+  </div>
diff --git a/tests/github/empty-nope.yml b/tests/github/empty-nope.yml
@@ -0,0 +1,10 @@
+input: |
+  > [!Warning]
+  >
+  >
+output: |-
+  <blockquote>
+    <p>
+      [!Warning]
+    </p>
+  </blockquote>
diff --git a/tests/github/extra-space.yml b/tests/github/extra-space.yml
@@ -0,0 +1,24 @@
+input: |
+  > [!Note] 
+  >  foo
+  <!-- -->
+  >  [!Note]
+  > foo
+output: |-
+  <div class="admonition note">
+    <p class="admonition-title">
+      Note
+    </p>
+    <p>
+      foo
+    </p>
+  </div>
+  <!-- -->
+  <div class="admonition note">
+    <p class="admonition-title">
+      Note
+    </p>
+    <p>
+      foo
+    </p>
+  </div>
diff --git a/tests/github/just-callout-nope.yml b/tests/github/just-callout-nope.yml
@@ -0,0 +1,28 @@
+input: |
+  > [!Warning]
+
+  hi
+  > [!Warning]
+  >
+  <!-- -->
+  >[!Warning]  
+output: |-
+  <blockquote>
+    <p>
+      [!Warning]
+    </p>
+  </blockquote>
+  <p>
+    hi
+  </p>
+  <blockquote>
+    <p>
+      [!Warning]
+    </p>
+  </blockquote>
+  <!-- -->
+  <blockquote>
+    <p>
+      [!Warning]
+    </p>
+  </blockquote>
diff --git a/tests/github/linebreak-after.yml b/tests/github/linebreak-after.yml
@@ -0,0 +1,16 @@
+input: |
+  > [!Note]
+  >  
+  > Body.  
+  > More.
+output: |-
+  <div class="admonition note">
+    <p class="admonition-title">
+      Note
+    </p>
+    <p>
+      Body.
+      <br/>
+      More.
+    </p>
+  </div>
diff --git a/tests/github/lowercase-nope.yml b/tests/github/lowercase-nope.yml
@@ -0,0 +1,11 @@
+input: |
+  > **note**: foo
+output: |-
+  <blockquote>
+    <p>
+      <strong>
+        note
+      </strong>
+      : foo
+    </p>
+  </blockquote>