Merge pull request #26 from sondregronas/feature/blank-title-support

sondregronas · web-flow · commit 65ddf3d27a32 · 2025-01-15T13:45:59.000+01:00
feat: add support for "blank" titles for colored blocks
diff --git a/pyproject.toml b/pyproject.toml
@@ -4,13 +4,13 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "mkdocs-callouts"
-version = "1.15.0"
+version = "1.16.0"
 keywords = ["mkdocs", "mkdocs-plugin", "markdown", "callouts", "admonitions", "obsidian"]
 description = "A simple plugin that converts Obsidian style callouts and converts them into mkdocs supported 'admonitions' (a.k.a. callouts)."
 readme = "README.md"
 requires-python = ">=3.8"
 authors = [{ name = "Sondre Grønås", email = "mail@sondregronas.com" }]
-license = {text = "MIT"}
+license = { text = "MIT" }
 classifiers = [
     "Development Status :: 5 - Production/Stable",
     "License :: OSI Approved :: MIT License",
diff --git a/src/mkdocs_callouts/utils.py b/src/mkdocs_callouts/utils.py
@@ -107,7 +107,14 @@ def _parse_block_syntax(self, block) -> str:
         # We use startswith to avoid issues with the inline block syntax
         if not title and not c_type.lower().startswith(clean_c_type.lower()):
             title = clean_c_type.capitalize()
-        title = f' "{title}"' if title else ""
+
+        # Render the title according to the syntax
+        if title in ['""', "''"]:
+            title = ' ""'  # Quotes = does not render the heading, only block content
+        elif title:
+            title = f' "{title}"'  # Title was provided, add quotation marks
+        else:
+            title = ""  # No title provided, use the default (Note, Warning, etc.)
 
         # Construct the new callout syntax ({indent}!!! note "Title")
         return f"{indent}{syntax} {c_type}{title}"
diff --git a/tests/demo_pages/docs/Tests/no_title.md b/tests/demo_pages/docs/Tests/no_title.md
@@ -0,0 +1,16 @@
+# Callouts without a title
+
+> [!NOTE] ""
+> This is a note without a title ("")
+
+> [!TIP] ''
+> This is a tip without a title ('')
+
+
+```md
+> [!NOTE] ""
+> This is a note without a title ("")
+
+> [!TIP] ''
+> This is a tip without a title ('')
+```
diff --git a/tests/test_plugin.py b/tests/test_plugin.py
@@ -434,4 +434,10 @@ def test_alias_titles():
     mkdown = "> [!cAuTiON] Title"
     result = "!!! warning \"Title\""
 
-    assert (convert(mkdown) == result)
+    assert (convert(mkdown) == result)
+
+def test_callout_blank_title():
+    mkdown = "> [!note] \"\"\n> Text"
+    result = "!!! note \"\"\n\tText"
+
+    assert (convert(mkdown) == result)
