🐛 Fix markdown formatting in --help output (#815)

Co-authored-by: svlandeg <[email protected]>
Co-authored-by: Sofie Van Landeghem <[email protected]>
Co-authored-by: Sebastián Ramírez <[email protected]>

Author: 3 people

tests/test_rich_markup_mode.py

@@ -49,7 +49,6 @@ def main(arg: str):
         pytest.param(
             "markdown",
             ["First line", "", "Line 1", "", "Line 2", "", "Line 3", ""],
-            marks=pytest.mark.xfail,
         ),
         pytest.param(
             "rich", ["First line", "", "Line 1", "", "Line 2", "", "Line 3", ""]
@@ -140,7 +139,6 @@ def main(arg: str):
                 "Line 3",
                 "",
             ],
-            marks=pytest.mark.xfail,
         ),
         pytest.param(
             "rich",

typer/rich_utils.py

@@ -190,7 +190,8 @@ def _get_help_text(
     help_text = help_text.partition("\f")[0]
 
     # Get the first paragraph
-    first_line = help_text.split("\n\n")[0]
+    first_line, *remaining_paragraphs = help_text.split("\n\n")
+
     # Remove single linebreaks
     if markup_mode != MARKUP_MODE_MARKDOWN and not first_line.startswith("\b"):
         first_line = first_line.replace("\n", " ")
@@ -200,13 +201,11 @@ def _get_help_text(
         markup_mode=markup_mode,
     )
 
-    # Add a newline inbetween the header and the remaining paragraphs
-    yield Text("")
-
     # Get remaining lines, remove single line breaks and format as dim
-    remaining_paragraphs = help_text.split("\n\n")[1:]
     if remaining_paragraphs:
-        if markup_mode != MARKUP_MODE_RICH:
+        # Add a newline inbetween the header and the remaining paragraphs
+        yield Text("")
+        if markup_mode not in (MARKUP_MODE_RICH, MARKUP_MODE_MARKDOWN):
             # Remove single linebreaks
             remaining_paragraphs = [
                 x.replace("\n", " ").strip()
@@ -217,7 +216,7 @@ def _get_help_text(
             # Join back together
             remaining_lines = "\n".join(remaining_paragraphs)
         else:
-            # Join with double linebreaks if markdown
+            # Join with double linebreaks if markdown or Rich markup
             remaining_lines = "\n\n".join(remaining_paragraphs)
 
         yield _make_rich_text(