Fix incorrect markdown escaping

Author: object-Object

CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and [Pydantic's HISTORY.md](https://github.com/pydantic/pydantic/blob/main/HISTORY.md), and this project *mostly* adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## `1!0.1.0a29`
+
+### Fixed
+
+* Fixed incorrect Markdown escaping in `macros/styles.md.jinja`.
+
 ## `1!0.1.0a28`
 
 ### Added

src/hexdoc/_templates/macros/formatting.jinja

@@ -1,10 +1,12 @@
 {# FormatTree handler #}
 {% macro styled(value, safe, separator, styles) -%}
   {%- if value is string -%}
-    {%- for line in value.splitlines() -%}
-      {{- line|safe if safe else line -}}
-      {%- if not loop.last -%}{{ separator }}{%- endif -%}
-    {%- endfor -%}
+    {%- call styles.plain_text() -%}
+      {%- for line in value.splitlines() -%}
+        {{- line|safe if safe else line -}}
+        {%- if not loop.last -%}{{ separator }}{%- endif -%}
+      {%- endfor -%}
+    {%- endcall -%}
   {%- elif value is not none -%}
     {%- call styles[value.style.macro](value.style) -%}
       {%- for child in value.children -%}

src/hexdoc/_templates/macros/styles.html.jinja

@@ -1,3 +1,7 @@
+{% macro plain_text() -%}
+  {{ caller() }}
+{%- endmacro %}
+
 {# CommandStyle #}
 
 {% macro command_obfuscated(style) -%}

src/hexdoc/_templates/macros/styles.md.jinja

@@ -1,3 +1,7 @@
+{% macro plain_text() -%}
+  {{ caller()|replace("*", "\\*") }}
+{%- endmacro %}
+
 {# CommandStyle #}
 
 {% macro command_obfuscated(style) -%}
@@ -52,9 +56,9 @@
 {# ParagraphStyle #}
 
 {% macro paragraph_paragraph(style) -%}
-  {{ caller() }}\n
+  {{ caller()~"\n" }}
 {%- endmacro %}
 
 {% macro paragraph_list_item(style) -%}
-{{ "  " * style.level }}* {{ caller() }}\n
+{{ "  " * style.level }}- {{ caller()~"\n" }}
 {%- endmacro %}

src/hexdoc/_templates/macros/styles.txt.jinja

@@ -1,3 +1,7 @@
+{% macro plain_text() -%}
+  {{ caller() }}
+{%- endmacro %}
+
 {# CommandStyle #}
 
 {% macro command_obfuscated(style) -%}

test/patchouli/test_text.py

@@ -46,18 +46,28 @@ def flatten_html(html: str):
     return "".join(line.lstrip() for line in html.splitlines())
 
 
-def hexdoc_block(value: FormatTree):
+def hexdoc_block(value: FormatTree, ext: str = "html"):
     loader = PackageLoader("hexdoc", "_templates")
     env = create_jinja_env_with_loader(loader)
     template = env.from_string(
         """\
-        {%- import "macros/formatting.html.jinja" as fmt with context -%}
+        {%- import "macros/formatting.{ext}.jinja" as fmt with context -%}
         {{- fmt.styled(value) -}}
-        """
+        """.replace("{ext}", ext)
     )
     return template.render(value=value)
 
 
+def test_markdown_escape():
+    tree = format_with_mocks(
+        "all ↗ makes the result $(bold)* 2 + 1/$, all → makes it $(bold)* 2/$, and all ↘ for $(bold)/ 10/$."
+    )
+    assert (
+        hexdoc_block(tree, "md")
+        == "all ↗ makes the result **\\* 2 + 1**, all → makes it **\\* 2**, and all ↘ for **/ 10**.\n"
+    )
+
+
 def test_link():
     tree = format_with_mocks("$(l:http://google.com)A$(/l)")
     assert (