markdown_convert 1.2.49__py3-none-any.whl → 1.2.51__py3-none-any.whl

markdown_convert/__init__.py

@@ -4,8 +4,8 @@ available to the user.
 Author: @julynx
 """
 
-from .modules.convert import convert, live_convert, convert_text
 from .__main__ import main
+from .modules.convert import convert, convert_text, live_convert
 
 __version__ = "1.2.15"
 __all__ = ["convert", "live_convert", "convert_text", "main"]

markdown_convert/__main__.py

@@ -8,7 +8,8 @@ Author: @julynx
 from sys import exit as sys_exit
 
 from argsdict import args
-from .modules.constants import RED, OPTIONS, OPTIONS_MODES
+
+from .modules.constants import OPTIONS, OPTIONS_MODES, RED
 from .modules.convert import convert, live_convert
 from .modules.resources import get_css_path, get_output_path, get_usage
 from .modules.utils import color
@@ -75,7 +76,6 @@ def main():
 
         sys_exit(0)
 
-    # pylint: disable=W0718
     except Exception as err:
         asked_for_help = "--help" in arg or "-h" in arg
         show_usage = isinstance(err, (IndexError, ValueError)) or asked_for_help

markdown_convert/default.css

@@ -24,6 +24,17 @@
   --color-border-light: #ccc;
   /* Hyperlinks */
   --color-links: #09f;
+
+  /* Note */
+  --color-ad-note: oklch(70% 0.1 238.77);
+  /* Tip */
+  --color-ad-tip: oklch(70% 0.1 142.605);
+  /* Important */
+  --color-ad-important: oklch(70% 0.1 284.67);
+  /* Warning */
+  --color-ad-warning: oklch(70% 0.1 74.25);
+  /* Caution */
+  --color-ad-caution: oklch(70% 0.1 14.4);
 }
 
 /* Document */
@@ -312,9 +323,9 @@ hr:has(+ hr) {
 
 hr+hr {
   clear: both;
-  break-after: always;
-  page-break-after: always;
   visibility: hidden;
+  page-break-after: always;
+  break-after: always;
 }
 
 section,
@@ -432,4 +443,83 @@ math {
 .justify {
   display: block;
   text-align: justify;
+}
+
+/* Admonitions */
+.admonition {
+  padding: 0.5rem 1rem;
+  margin-bottom: 1rem;
+  border-left: 0.25rem solid;
+  border-radius: 0.3rem;
+}
+
+.admonition header {
+  display: flex;
+  align-items: center;
+  gap: 0.25rem;
+  margin-bottom: 0.25rem;
+  font-weight: bold;
+}
+
+.admonition strong {
+  text-transform: capitalize;
+}
+
+.admonition em:not(:empty)::before {
+  content: ": ";
+  font-weight: bold;
+}
+
+.admonition em {
+  font-weight: 600;
+  font-style: normal;
+}
+
+.admonition p {
+  margin: 0;
+}
+
+.admonition.note {
+  border-left-color: var(--color-ad-note);
+  background-color: oklch(from var(--color-ad-note) 0.97 0.015 h);
+}
+
+.admonition.note strong {
+  color: var(--color-ad-note);
+}
+
+.admonition.tip {
+  border-left-color: var(--color-ad-tip);
+  background-color: oklch(from var(--color-ad-tip) 0.97 0.015 h);
+}
+
+.admonition.tip strong {
+  color: var(--color-ad-tip);
+}
+
+.admonition.important {
+  border-left-color: var(--color-ad-important);
+  background-color: oklch(from var(--color-ad-important) 0.97 0.015 h);
+}
+
+.admonition.important strong {
+  color: var(--color-ad-important);
+}
+
+.admonition.warning {
+  border-left-color: var(--color-ad-warning);
+  background-color: oklch(from var(--color-ad-warning) 0.97 0.015 h);
+}
+
+.admonition.warning strong {
+  color: var(--color-ad-warning);
+}
+
+.admonition.caution {
+  border-left-color: var(--color-ad-caution);
+  background-color: oklch(from var(--color-ad-caution) 0.97 0.015 h);
+}
+
+.admonition.caution strong {
+  color: var(--color-ad-caution);
 }

markdown_convert/modules/autoinstall.py

@@ -0,0 +1,71 @@
+"""
+Autoinstall chromium headless browser for playwright.
+"""
+
+import os
+
+from install_playwright import install
+from playwright.sync_api import sync_playwright
+
+from .constants import GREEN, RED
+from .utils import color
+
+
+def ensure_chromium(loud=True):
+    """
+    Ensures the chromium playwright browser is installed.
+    If not, tries to install it.
+    """
+    with sync_playwright() as playwright:
+        if is_browser_installed(playwright.chromium):
+            return
+
+        if loud:
+            print(
+                "The Playwright Chromium browser was not found."
+                " Attempting to install it, please wait..."
+            )
+
+        try:
+            result = install([playwright.chromium])
+            if not result:
+                result = install([playwright.chromium], with_deps=True)
+
+            if loud:
+                if result:
+                    print(
+                        color(
+                            GREEN,
+                            "The Playwright Chromium browser was successfully installed.\n",
+                        )
+                    )
+                else:
+                    print(
+                        color(
+                            RED,
+                            "ERROR: The Playwright Chromium browser could not be automatically installed."
+                            "\nPlease manually run 'playwright install' and try again.\n",
+                        )
+                    )
+
+            return result
+
+        except Exception as exc:
+            print(
+                color(
+                    RED,
+                    f"ERROR: There was an exception while trying to install the Playwright Chromium browser:\n{exc}",
+                )
+            )
+            return False
+
+
+def is_browser_installed(browser):
+    """
+    Checks if a specific browser is installed by verifying its executable path.
+    Browser type can be 'chromium', 'firefox', or 'webkit'.
+    """
+    try:
+        return os.path.exists(browser.executable_path)
+    except Exception:
+        return False

markdown_convert/modules/constants.py

@@ -22,6 +22,7 @@ MARKDOWN_EXTENSIONS = {
     "latex": True,
     "mermaid": None,
     "strike": None,
+    "admonitions": None,
 }
 
 BROWSER_ARGS = [

markdown_convert/modules/convert.py

@@ -12,13 +12,19 @@ from pathlib import Path
 import markdown2
 from playwright.sync_api import sync_playwright
 
-from .constants import MARKDOWN_EXTENSIONS, BROWSER_ARGS, CSP_TEMPLATE, PDF_PARAMS
+from .autoinstall import ensure_chromium
+from .constants import (
+    BROWSER_ARGS,
+    CSP_TEMPLATE,
+    MARKDOWN_EXTENSIONS,
+    PDF_PARAMS,
+)
 from .resources import get_code_css_path, get_css_path, get_output_path
 from .transform import (
-    create_sections,
-    render_mermaid_diagrams,
     create_html_document,
+    create_sections,
     render_extra_features,
+    render_mermaid_diagrams,
 )
 from .utils import drop_duplicates
 
@@ -50,6 +56,7 @@ def _generate_pdf_with_playwright(
     csp = CSP_TEMPLATE.format(nonce=nonce)
     full_html = create_html_document(html_content, css_content, csp)
 
+    ensure_chromium()
     with sync_playwright() as playwright:
         browser = playwright.chromium.launch(headless=True, args=BROWSER_ARGS)
         context = browser.new_context(

markdown_convert/modules/extras.py

@@ -0,0 +1,100 @@
+"""
+Extras are defined as helper functions called by
+render_extra_features from transform.py
+"""
+
+
+def create_checkbox(soup, match):
+    """
+    Render a tag for a checkbox.
+
+    Args:
+        soup: HTML beautifulsoup
+        match: Element identified as a checkbox
+    Returns:
+        tag: Beautifulsoup tag representing the checkbox
+    """
+    tag = soup.new_tag("input", type="checkbox")
+    if "[x]" in match.group("checkbox"):
+        tag["checked"] = ""
+    return tag
+
+
+def create_highlight(soup, match):
+    """
+    Render a tag for a highlight.
+
+    Args:
+        soup: HTML beautifulsoup
+        match: Element identified as a highlight
+    Returns:
+        tag: Beautifulsoup tag representing the highlight
+    """
+    tag = soup.new_tag("span", attrs={"class": "highlight"})
+    tag.string = match.group("hl_content")
+    return tag
+
+
+def create_custom_span(soup, match):
+    """
+    Render a tag for a custom span.
+
+    Args:
+        soup: HTML beautifulsoup
+        match: Element identified as a custom span
+    Returns:
+        tag: Beautifulsoup tag representing the custom span
+    """
+    tag = soup.new_tag("span", attrs={"class": match.group("cls")})
+    tag.string = match.group("sp_content")
+    return tag
+
+
+def create_toc(soup, match):
+    """
+    Render a tag for a table of contents
+
+    Args:
+        soup: HTML beautifulsoup
+        match: Element identified as a table of contents
+    Returns:
+        tag: Beautifulsoup tag representing the table of contents
+    """
+    max_level = match.group("depth")
+    max_level = 3 if max_level is None else int(max_level)
+
+    headers = [
+        header
+        for header in soup.find_all([f"h{index}" for index in range(1, max_level + 1)])
+        if header.get("id")
+    ]
+    if not headers:
+        return ""
+
+    tag = soup.new_tag("ul", attrs={"class": "toc"})
+    active_list = {0: tag}
+    last_list_element = {}
+
+    for header in headers:
+        level = int(header.name[1])
+
+        if level not in active_list:
+            parent_lvl = max(key for key in active_list if key < level)
+            if last_list_element.get(parent_lvl):
+                sub_list = soup.new_tag("ul")
+                last_list_element[parent_lvl].append(sub_list)
+                active_list[level] = sub_list
+            else:
+                active_list[level] = active_list[parent_lvl]
+
+        active_list = {key: value for key, value in active_list.items() if key <= level}
+
+        list_item = soup.new_tag("li")
+        link = soup.new_tag("a", href=f"#{header['id']}")
+        link.string = header.get_text(strip=True)
+        list_item.append(link)
+
+        active_list[level].append(list_item)
+        last_list_element[level] = list_item
+
+    return tag

markdown_convert/modules/resources.py

@@ -13,7 +13,7 @@ except ImportError:
     # Fallback for older Python versions
     from importlib_resources import files
 
-from .constants import BLUE, CYAN, GREEN, YELLOW, OPTIONS, OPTIONS_MODES
+from .constants import BLUE, CYAN, GREEN, OPTIONS, OPTIONS_MODES, YELLOW
 from .utils import color
 
 

markdown_convert/modules/transform.py

@@ -6,6 +6,10 @@ import re
 
 from bs4 import BeautifulSoup
 
+from .constants import YELLOW
+from .extras import create_checkbox, create_custom_span, create_highlight, create_toc
+from .utils import color
+
 
 def create_html_document(html_content, css_content, csp):
     """
@@ -34,8 +38,8 @@ def create_html_document(html_content, css_content, csp):
 
 def create_sections(html_string):
     """
-    Wraps each h2 or h3 and its following content in a <section> tag.
-    The section ends when the next h2 or h3 is encountered, or the parent ends.
+    Wraps each h2 and its following content in a <section> tag.
+    The section ends when the next h2 is encountered, or the parent ends.
 
     Args:
         html_string (str): The input HTML string.
@@ -44,14 +48,12 @@ def create_sections(html_string):
     """
     soup = BeautifulSoup(html_string, "html.parser")
 
-    for header in soup.find_all(["h2", "h3"]):
+    for header in soup.find_all("h2"):
         new_section = soup.new_tag("section")
         header.insert_before(new_section)
 
         current = header
-        while current is not None and (
-            current == header or current.name not in ["h2", "h3"]
-        ):
+        while current is not None and (current == header or current.name != "h2"):
             next_sibling = current.next_sibling
             new_section.append(current)
             current = next_sibling
@@ -97,32 +99,18 @@ def render_extra_features(html):
         str: HTML content with extra features rendered.
     """
 
-    def _create_checkbox(soup, match):
-        tag = soup.new_tag("input", type="checkbox")
-        if "[x]" in match.group("checkbox"):
-            tag["checked"] = ""
-        return tag
-
-    def _create_highlight(soup, match):
-        tag = soup.new_tag("span", attrs={"class": "highlight"})
-        tag.string = match.group("hl_content")
-        return tag
-
-    def _create_custom_span(soup, match):
-        tag = soup.new_tag("span", attrs={"class": match.group("cls")})
-        tag.string = match.group("sp_content")
-        return tag
-
     handlers = {
-        "checkbox": _create_checkbox,
-        "highlight": _create_highlight,
-        "span": _create_custom_span,
+        "checkbox": create_checkbox,
+        "highlight": create_highlight,
+        "span": create_custom_span,
+        "toc": create_toc,
     }
 
     master_pattern = re.compile(
         r"(?P<checkbox>\[\s\]|\[x\])|"
         r"(?P<highlight>==(?P<hl_content>.*?)==)|"
-        r"(?P<span>(?P<cls>[a-zA-Z0-9_-]+)\{\{\s*(?P<sp_content>.*?)\s*\}\})"
+        r"(?P<span>(?P<cls>[a-zA-Z0-9_-]+)\{\{\s*(?P<sp_content>.*?)\s*\}\})|"
+        r"(?P<toc>\[TOC(?:\s+depth=(?P<depth>\d+))?\])"
     )
 
     ignored_tags = {"code", "pre", "script", "style"}
@@ -156,7 +144,12 @@ def render_extra_features(html):
                     tag = handler(soup, match)
                     new_nodes.append(tag)
                 except Exception as exc:
-                    print(f"Warning: Handler for '{kind}' failed with exception: {exc}")
+                    print(
+                        color(
+                            YELLOW,
+                            f"WARNING: Handler for '{kind}' failed with exception: {exc}",
+                        )
+                    )
                     new_nodes.append(match.group(0))
 
             last_end = end

{markdown_convert-1.2.49.dist-info → markdown_convert-1.2.51.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: markdown_convert
-Version: 1.2.49
+Version: 1.2.51
 Summary: Convert Markdown files to PDF from your command line.
 Project-URL: homepage, https://github.com/Julynx/markdown_convert
 Author-email: Julio Cabria <juliocabria@tutanota.com>
@@ -12,6 +12,7 @@ Classifier: Programming Language :: Python :: 3
 Requires-Python: <3.15,>=3.11
 Requires-Dist: argsdict==1.0.0
 Requires-Dist: beautifulsoup4>=4.14.3
+Requires-Dist: install-playwright>=1.0.0
 Requires-Dist: latex2mathml>=3.78.1
 Requires-Dist: markdown2<3,>=2.4.13
 Requires-Dist: playwright>=1.57.0

markdown_convert-1.2.51.dist-info/RECORD

@@ -0,0 +1,18 @@
+markdown_convert/__init__.py,sha256=0hLMtJnCIuApqopx5P4tiDSw850AmnuVcohmAbPVEZ4,303
+markdown_convert/__main__.py,sha256=AocRo1iF1El_-Uo0owJ-QLbJUF0rum5R_AlNrTTTSOQ,2780
+markdown_convert/code.css,sha256=Wt4FqFqJcpT-jwY3GN-o4ZRCCXU8DQj-9lqKdGiuoyw,4935
+markdown_convert/default.css,sha256=XmIR6Kx4evwmLTZr9QZc3XhDj4jxjmGkwaeftfvHNmU,8149
+markdown_convert/modules/__init__.py,sha256=PFPgiQhMXgyfjD8BkfLC_X8AR1jz-dCxfif2qmNofJs,65
+markdown_convert/modules/autoinstall.py,sha256=Tnrde6MIcO11PWT7GZwhs_QTVRy6CSpUB_gIi9G5ve8,2063
+markdown_convert/modules/constants.py,sha256=FA8DrQa9nzTUIJFXwXrK-AuOc5_ToGSFaD4sJqsnAjU,1305
+markdown_convert/modules/convert.py,sha256=1AjQfnOXJoxKyfqr4misDuTvE4YXnwaoWw668FUHiEQ,8972
+markdown_convert/modules/extras.py,sha256=GwNx6nseztHOWExcYmovxomdvOs078dMeknQTwzTCJo,2730
+markdown_convert/modules/resources.py,sha256=eskLLbrkLJWs-vqtCLq4qV2Hjy6XeGFCUdT0VN2b_tA,2488
+markdown_convert/modules/transform.py,sha256=e4QllWx5BYKEQqIzOkYigtxcSAWqSUHsoKkvqzYzEpY,4567
+markdown_convert/modules/utils.py,sha256=NX0WegM8e8MPKNNmweTujAWO8ZghdB8LSGDx20K2E44,655
+markdown_convert/modules/validate.py,sha256=XV_k7cHeifEKDaltF26tCmabs2-Me5msP3enI_eVwfA,1517
+markdown_convert-1.2.51.dist-info/METADATA,sha256=sejp1Y3EzxGpfMqDxIJsieDaxkO9_o0gFffs7ULpwKw,4118
+markdown_convert-1.2.51.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+markdown_convert-1.2.51.dist-info/entry_points.txt,sha256=RCmzC7C0sX-SpzIP2Cr34rhg3lMd7BRx-exaZPfK8bU,68
+markdown_convert-1.2.51.dist-info/licenses/LICENSE,sha256=gXf5dRMhNSbfLPYYTY_5hsZ1r7UU1OaKQEAQUhuIBkM,18092
+markdown_convert-1.2.51.dist-info/RECORD,,

markdown_convert-1.2.49.dist-info/RECORD

@@ -1,16 +0,0 @@
-markdown_convert/__init__.py,sha256=ysW3pXsDGGK4PzZHcIBTpfVW58IkDUwHffDkf_GM6UU,303
-markdown_convert/__main__.py,sha256=w6sHfJcJQpMOERPqiNoKgoRM38YUwK22eGBmVkpZj1g,2807
-markdown_convert/code.css,sha256=Wt4FqFqJcpT-jwY3GN-o4ZRCCXU8DQj-9lqKdGiuoyw,4935
-markdown_convert/default.css,sha256=ZL2f-SQIM2BG1sGD51wRqTN06K2rnIYyELXdJQq1xRs,6355
-markdown_convert/modules/__init__.py,sha256=PFPgiQhMXgyfjD8BkfLC_X8AR1jz-dCxfif2qmNofJs,65
-markdown_convert/modules/constants.py,sha256=eUeIFRxZerP3E0Rgp_Nsl0Q38IBELwca5UO3fbUcxRA,1280
-markdown_convert/modules/convert.py,sha256=4UEZhx_v4lqcgTYeCiQ3V4Bkxz4siHCKQIHGvHICHuI,8888
-markdown_convert/modules/resources.py,sha256=tnW8JmCrJNBRbzOcaOVG6GX5jPC8Kzj3dA7gX0B935A,2488
-markdown_convert/modules/transform.py,sha256=_Pz-t_7g_n_IwtHtc386WDugkw6CfDpdgw_aFgiSM4Q,4796
-markdown_convert/modules/utils.py,sha256=NX0WegM8e8MPKNNmweTujAWO8ZghdB8LSGDx20K2E44,655
-markdown_convert/modules/validate.py,sha256=XV_k7cHeifEKDaltF26tCmabs2-Me5msP3enI_eVwfA,1517
-markdown_convert-1.2.49.dist-info/METADATA,sha256=PkXwu7z2NarPFUwveuXstMJ-I2jQfdF8WzMZ9LwfZfA,4077
-markdown_convert-1.2.49.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-markdown_convert-1.2.49.dist-info/entry_points.txt,sha256=RCmzC7C0sX-SpzIP2Cr34rhg3lMd7BRx-exaZPfK8bU,68
-markdown_convert-1.2.49.dist-info/licenses/LICENSE,sha256=gXf5dRMhNSbfLPYYTY_5hsZ1r7UU1OaKQEAQUhuIBkM,18092
-markdown_convert-1.2.49.dist-info/RECORD,,