Added Support for Line Breaks in Inline Elements (#168)

* Added linebreak conceptually

* Doesn't work when extended to Paragraph

* Tried the alternative of embedding the line break

* Updated docs and version

* Converted to self-closing tag to mirror markdown python library

* Updated testing to match self-closing tag

* Removed tags

Author: jrg94

docs/version-history.rst

@@ -13,19 +13,23 @@ as follows:
 v2.x
 ----
 
-* v2.2.1 [:pr:`#164`]
+* v2.3.0 [:pr:`168`]
+
+  * Added a line break option to Inline text to grant a little more control over formatting
+
+* v2.2.1 [:pr:`164`]
 
   * Fixed a bug where headings with special characters would not link properly in the table of contents
   * Dropped support for Python 3.8 due to deprecation
   * Added support for Python 3.12 and 3.13
 
-* v2.2.0 [:pr:`#152`, :pr:`153`, :pr:`#159`]
+* v2.2.0 [:pr:`152`, :pr:`153`, :pr:`159`]
 
   * Added documentation throughout the repo
   * Expanded testing
   * Added CSVTable Template and accompanying documentation
 
-* v2.2.0b1 [:pr:`#140`, :pr:`#142`, :pr:`#143`, :pr:`#144`, :pr:`#145`, :pr:`#146`, :pr:`#149`]
+* v2.2.0b1 [:pr:`140`, :pr:`142`, :pr:`143`, :pr:`144`, :pr:`145`, :pr:`146`, :pr:`149`]
 
   * Expanded the Element requirements to include :code:`__repr__()` for developer friendly strings
   * Reworked logging system to take advantage of lazy loading and new :code:`__repr__()` methods

pyproject.toml

@@ -2,7 +2,7 @@
 [tool.poetry]
 name = "SnakeMD"
 description = "A markdown generation library for Python."
-version = "2.2.1"
+version = "2.3.0"
 license = "MIT"
 
 authors = [

snakemd/elements.py

@@ -104,6 +104,11 @@ class Inline(Element):
 
         - defaults to :code:`False`
         - set to :code:`True` to render text as code (i.e., ```text```)
+    :param bool linebreak:
+        the line break state of the inline text
+        
+        - defaults to :code:`False`
+        - set to :code:`True` to add a line break to the end of the element (i.e., `<br>`)
     """
 
     def __init__(
@@ -115,6 +120,7 @@ def __init__(
         italics: bool = False,
         strikethrough: bool = False,
         code: bool = False,
+        linebreak: bool = False,
     ) -> None:
         self._text = text
         self._image = image
@@ -123,6 +129,7 @@ def __init__(
         self._italics = italics
         self._strikethrough = strikethrough
         self._code = code
+        self._linebreak = linebreak
 
     def __str__(self) -> str:
         """
@@ -152,6 +159,10 @@ def __str__(self) -> str:
             text = f"~~{text}~~"
         if self._code:
             text = f"`{text}`"
+        if self._linebreak:
+            # Note: doing this the markdown way (i.e., space-space-newline)
+            # does not work with the current implementation of Paragraph
+            text = f"{text}<br />"
         logger.debug("Rendered inline text: %r", text)
         return text
 

tests/elements/test_inline.py

@@ -200,6 +200,12 @@ def test_inline_code():
         ")"
     )
     assert markdown.markdown(str(text)) == "<p><code>x = 7</code></p>"
+    
+
+def test_inline_linebreak():
+    text = Inline("Test", linebreak=True)
+    assert str(text) == "Test<br />"
+    assert markdown.markdown(str(text)) == "<p>Test<br /></p>"
 
 
 # Constructor tests (2-combos)

tests/elements/test_paragraph.py

@@ -145,3 +145,11 @@ def test_repr_can_create_object():
     paragraph = Paragraph("")
     obj = eval(repr(paragraph))
     assert isinstance(obj, Paragraph)
+    
+
+def test_paragraph_with_linebreak():
+    paragraph = Paragraph([
+        Inline("First Line", linebreak=True), 
+        Inline("Second Line")
+    ])
+    assert str(paragraph) == "First Line<br />Second Line"