mkdocs2confluence 0.6.5__tar.gz → 0.6.7__tar.gz

{mkdocs2confluence-0.6.5/src/mkdocs2confluence.egg-info → mkdocs2confluence-0.6.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs2confluence
-Version: 0.6.5
+Version: 0.6.7
 Summary: Publish MkDocs Material pages to Confluence Cloud — admonitions, Mermaid diagrams, tabs, page properties and more
 Author: Anders Hybertz
 License: GPL-3.0-or-later
@@ -36,7 +36,7 @@ Requires-Dist: bandit; extra == "dev"
 Requires-Dist: build; extra == "dev"
 Dynamic: license-file
 
-# mk2conf — MkDocs to Confluence
+# mk2conf — MkDocs / Zensical to Confluence
 
 [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
 [![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
@@ -54,6 +54,8 @@ A Python CLI tool that compiles MkDocs-flavoured Markdown into native Confluence
 
 It is a **compiler/transpiler**, not an HTML converter — every Markdown construct is mapped to the equivalent native Confluence macro or element, so pages look and behave like hand-authored Confluence content.
 
+> **Zensical compatible** — [Zensical](https://zensical.org/) is the modern successor to MkDocs + Material for MkDocs, built by the same team. Since Zensical uses the same `mkdocs.yml` format and Python Markdown extensions, your Zensical project works with this tool today — no changes required.
+
 ---
 
 ## Architecture
@@ -255,12 +257,16 @@ extra_css:
 | `**bold**` / `__bold__` | `<strong>` |
 | `*italic*` | `<em>` |
 | `~~strikethrough~~` | `<s>` |
+| `~subscript~` | `<sub>` (pymdownx.tilde) |
+| `^superscript^` | `<sup>` (pymdownx.caret) |
+| `^^inserted^^` | `<u>` (pymdownx.caret insert) |
 | `` `inline code` `` | `<code>` |
 | `[text](url)` | `<a href="...">` |
+| `https://bare-url` | `<a href="...">` (autolink) |
 | `[text](file.pdf)` | `<ac:link><ri:attachment .../>` (uploaded as attachment) |
 | `![alt](src)` | `<ac:image>` with `<ri:attachment>` (local) or `<ri:url>` (remote) |
 | `![alt](src){ width="400" }` | `<ac:image ac:width="400">` — also supports `height` and `align` |
-| `<br>` / `<br/>` | `<br />` |
+| `<br>` / `<br/>` / trailing `\` | `<br />` |
 | `<sub>` / `<sup>` / `<u>` / `<small>` | Direct XHTML passthrough |
 | `<mark>text</mark>` | `<span style="background-color: yellow;">` |
 | `<kbd>text</kbd>` | `<code>` |

{mkdocs2confluence-0.6.5 → mkdocs2confluence-0.6.7}/README.md

@@ -1,4 +1,4 @@
-# mk2conf — MkDocs to Confluence
+# mk2conf — MkDocs / Zensical to Confluence
 
 [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
 [![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
@@ -16,6 +16,8 @@ A Python CLI tool that compiles MkDocs-flavoured Markdown into native Confluence
 
 It is a **compiler/transpiler**, not an HTML converter — every Markdown construct is mapped to the equivalent native Confluence macro or element, so pages look and behave like hand-authored Confluence content.
 
+> **Zensical compatible** — [Zensical](https://zensical.org/) is the modern successor to MkDocs + Material for MkDocs, built by the same team. Since Zensical uses the same `mkdocs.yml` format and Python Markdown extensions, your Zensical project works with this tool today — no changes required.
+
 ---
 
 ## Architecture
@@ -217,12 +219,16 @@ extra_css:
 | `**bold**` / `__bold__` | `<strong>` |
 | `*italic*` | `<em>` |
 | `~~strikethrough~~` | `<s>` |
+| `~subscript~` | `<sub>` (pymdownx.tilde) |
+| `^superscript^` | `<sup>` (pymdownx.caret) |
+| `^^inserted^^` | `<u>` (pymdownx.caret insert) |
 | `` `inline code` `` | `<code>` |
 | `[text](url)` | `<a href="...">` |
+| `https://bare-url` | `<a href="...">` (autolink) |
 | `[text](file.pdf)` | `<ac:link><ri:attachment .../>` (uploaded as attachment) |
 | `![alt](src)` | `<ac:image>` with `<ri:attachment>` (local) or `<ri:url>` (remote) |
 | `![alt](src){ width="400" }` | `<ac:image ac:width="400">` — also supports `height` and `align` |
-| `<br>` / `<br/>` | `<br />` |
+| `<br>` / `<br/>` / trailing `\` | `<br />` |
 | `<sub>` / `<sup>` / `<u>` / `<small>` | Direct XHTML passthrough |
 | `<mark>text</mark>` | `<span style="background-color: yellow;">` |
 | `<kbd>text</kbd>` | `<code>` |

{mkdocs2confluence-0.6.5 → mkdocs2confluence-0.6.7}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mkdocs2confluence"
-version = "0.6.5"
+version = "0.6.7"
 description = "Publish MkDocs Material pages to Confluence Cloud — admonitions, Mermaid diagrams, tabs, page properties and more"
 readme = "README.md"
 license = { text = "GPL-3.0-or-later" }

{mkdocs2confluence-0.6.5 → mkdocs2confluence-0.6.7/src/mkdocs2confluence.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs2confluence
-Version: 0.6.5
+Version: 0.6.7
 Summary: Publish MkDocs Material pages to Confluence Cloud — admonitions, Mermaid diagrams, tabs, page properties and more
 Author: Anders Hybertz
 License: GPL-3.0-or-later
@@ -36,7 +36,7 @@ Requires-Dist: bandit; extra == "dev"
 Requires-Dist: build; extra == "dev"
 Dynamic: license-file
 
-# mk2conf — MkDocs to Confluence
+# mk2conf — MkDocs / Zensical to Confluence
 
 [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
 [![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
@@ -54,6 +54,8 @@ A Python CLI tool that compiles MkDocs-flavoured Markdown into native Confluence
 
 It is a **compiler/transpiler**, not an HTML converter — every Markdown construct is mapped to the equivalent native Confluence macro or element, so pages look and behave like hand-authored Confluence content.
 
+> **Zensical compatible** — [Zensical](https://zensical.org/) is the modern successor to MkDocs + Material for MkDocs, built by the same team. Since Zensical uses the same `mkdocs.yml` format and Python Markdown extensions, your Zensical project works with this tool today — no changes required.
+
 ---
 
 ## Architecture
@@ -255,12 +257,16 @@ extra_css:
 | `**bold**` / `__bold__` | `<strong>` |
 | `*italic*` | `<em>` |
 | `~~strikethrough~~` | `<s>` |
+| `~subscript~` | `<sub>` (pymdownx.tilde) |
+| `^superscript^` | `<sup>` (pymdownx.caret) |
+| `^^inserted^^` | `<u>` (pymdownx.caret insert) |
 | `` `inline code` `` | `<code>` |
 | `[text](url)` | `<a href="...">` |
+| `https://bare-url` | `<a href="...">` (autolink) |
 | `[text](file.pdf)` | `<ac:link><ri:attachment .../>` (uploaded as attachment) |
 | `![alt](src)` | `<ac:image>` with `<ri:attachment>` (local) or `<ri:url>` (remote) |
 | `![alt](src){ width="400" }` | `<ac:image ac:width="400">` — also supports `height` and `align` |
-| `<br>` / `<br/>` | `<br />` |
+| `<br>` / `<br/>` / trailing `\` | `<br />` |
 | `<sub>` / `<sup>` / `<u>` / `<small>` | Direct XHTML passthrough |
 | `<mark>text</mark>` | `<span style="background-color: yellow;">` |
 | `<kbd>text</kbd>` | `<code>` |

{mkdocs2confluence-0.6.5 → mkdocs2confluence-0.6.7}/src/mkdocs_to_confluence/emitter/xhtml.py

@@ -37,6 +37,7 @@ from mkdocs_to_confluence.ir.nodes import (
     HorizontalRule,
     ImageNode,
     InlineHtmlNode,
+    InsertNode,
     IRNode,
     ItalicNode,
     LineBreakNode,
@@ -548,6 +549,8 @@ def _emit_inline(node: IRNode) -> str:
         return f"<sub>{_emit_inlines(node.children)}</sub>"
     if isinstance(node, SuperscriptNode):
         return f"<sup>{_emit_inlines(node.children)}</sup>"
+    if isinstance(node, InsertNode):
+        return f"<u>{_emit_inlines(node.children)}</u>"
     if isinstance(node, CodeInlineNode):
         style_attr = styles_to_attr(_styles.code_inline) if _styles else ""
         return f"<code{style_attr}>{html.escape(node.code)}</code>"

{mkdocs2confluence-0.6.5 → mkdocs2confluence-0.6.7}/src/mkdocs_to_confluence/ir/__init__.py

@@ -32,6 +32,7 @@ from mkdocs_to_confluence.ir.nodes import (
     ImageNode,
     # Inline HTML nodes
     InlineHtmlNode,
+    InsertNode,
     # Traversal utility
     IRNode,
     ItalicNode,
@@ -79,6 +80,7 @@ __all__ = [
     "ImageNode",
     "LineBreakNode",
     "InlineHtmlNode",
+    "InsertNode",
     # Block
     "Section",
     "Paragraph",

{mkdocs2confluence-0.6.5 → mkdocs2confluence-0.6.7}/src/mkdocs_to_confluence/ir/nodes.py

@@ -73,6 +73,13 @@ class SubscriptNode(IRNode):
     children: tuple[IRNode, ...]
 
 
+@dataclass(frozen=True)
+class InsertNode(IRNode):
+    """Inserted (underlined) inline content (``^^text^^``)."""
+
+    children: tuple[IRNode, ...]
+
+
 @dataclass(frozen=True)
 class CodeInlineNode(IRNode):
     """An inline code span (`` `code` ``)."""

{mkdocs2confluence-0.6.5 → mkdocs2confluence-0.6.7}/src/mkdocs_to_confluence/loader/config.py

@@ -7,6 +7,7 @@ import re
 from dataclasses import dataclass
 from pathlib import Path
 from typing import Any
+from urllib.parse import urlparse
 
 import yaml
 
@@ -118,9 +119,13 @@ def _default_edit_uri(repo_url: str | None) -> str | None:
     """Return a sensible default ``edit_uri`` based on the hosting platform."""
     if not repo_url:
         return None
-    if "github.com" in repo_url:
+    try:
+        hostname = urlparse(repo_url).hostname or ""
+    except ValueError:
+        return None
+    if hostname == "github.com" or hostname.endswith(".github.com"):
         return "edit/main/docs/"
-    if "gitlab.com" in repo_url or "gitlab." in repo_url:
+    if hostname == "gitlab.com" or hostname.endswith(".gitlab.com") or "gitlab" in hostname:
         return "-/edit/master/docs/"
     return None
 

{mkdocs2confluence-0.6.5 → mkdocs2confluence-0.6.7}/src/mkdocs_to_confluence/parser/markdown.py

@@ -1,24 +1,36 @@
-"""Minimal markdown-to-IR parser.
-
-Supported in this milestone
+"""Markdown-to-IR parser.
+
+Supported inline constructs
+----------------------------
+* ``**bold**`` / ``__bold__`` → :class:`~ir.BoldNode`
+* ``*italic*`` → :class:`~ir.ItalicNode`
+* ``~~strikethrough~~`` → :class:`~ir.StrikethroughNode`
+* ``~subscript~`` → :class:`~ir.SubscriptNode`
+* ``^superscript^`` → :class:`~ir.SuperscriptNode`
+* ``^^insert^^`` (underline) → :class:`~ir.InsertNode`
+* `` `code` `` → :class:`~ir.CodeInlineNode`
+* ``[text](url)`` → :class:`~ir.LinkNode`
+* Bare ``https://`` / ``http://`` URLs → :class:`~ir.LinkNode`
+* ``![alt](src)`` → :class:`~ir.ImageNode`
+* ``<br>`` / ``<br/>`` / trailing ``\\`` → :class:`~ir.LineBreakNode`
+* ``<mark>``, ``<kbd>``, ``<sub>``, ``<sup>``, ``<u>``, ``<s>``, ``<small>`` → :class:`~ir.InlineHtmlNode`
+* ``++key+key++`` → :class:`~ir.InlineHtmlNode` ``kbd`` (pymdownx.keys)
+* ``[^label]`` footnote references → :class:`~ir.FootnoteRef`
+
+Supported block constructs
 ---------------------------
 * ATX headings (``# H1`` … ``###### H6``) → :class:`~ir.Section`
 * Fenced code blocks (`` ``` `` or ``~~~``) → :class:`~ir.CodeBlock`
   with full Material attribute parsing (language, title, linenums, hl_lines)
 * Paragraphs (consecutive non-blank lines) → :class:`~ir.Paragraph`
 * Admonitions (``!!!``/``???``/``???+``) → :class:`~ir.Admonition`
-  Body is recursively tokenized, so nested code blocks and paragraphs work.
-
-Not yet supported (later milestones)
---------------------------------------
-* Inline formatting (bold, italic, links, images)
-* Content tabs, mermaid diagrams
-* Setext headings (underline style)
-* Block quotes, lists, tables, horizontal rules
-
-Inline content of headings and paragraphs is represented as a single
-:class:`~ir.TextNode` carrying the raw text; once the inline parser is
-implemented that node will be replaced by structured inline nodes.
+* Content tabs (``=== "Label"``) → :class:`~ir.ContentTabs`
+* Ordered and unordered lists, incl. task lists (``- [x]``) → :class:`~ir.BulletList` / :class:`~ir.OrderedList`
+* Tables → :class:`~ir.Table`
+* Definition lists → :class:`~ir.DefinitionList`
+* Block quotes → :class:`~ir.BlockQuote`
+* Horizontal rules → :class:`~ir.HorizontalRule`
+* Mermaid fenced blocks → :class:`~ir.MermaidDiagram`
 
 Architecture notes
 ------------------
@@ -57,6 +69,7 @@ from mkdocs_to_confluence.ir.nodes import (
     HorizontalRule,
     ImageNode,
     InlineHtmlNode,
+    InsertNode,
     IRNode,
     ItalicNode,
     LineBreakNode,
@@ -833,6 +846,16 @@ def _scan_inline(text: str, fn_map: dict[str, int] | None = None) -> list[IRNode
                 i = close_idx + 1
                 continue
 
+        # Insert (underline): ^^text^^  — checked before single ^
+        if text[i : i + 2] == "^^":
+            close_idx = text.find("^^", i + 2)
+            if close_idx != -1:
+                flush()
+                inner = _scan_inline(text[i + 2 : close_idx], _fn)
+                nodes.append(InsertNode(children=tuple(inner)))
+                i = close_idx + 2
+                continue
+
         # Superscript: ^text^
         if text[i] == "^":
             close_idx = text.find("^", i + 1)
@@ -878,6 +901,16 @@ def _scan_inline(text: str, fn_map: dict[str, int] | None = None) -> list[IRNode
                     i = close_idx + len(close)
                     continue
 
+        # Bare URL autolink: https:// or http://
+        if text[i : i + 4] in ("http", "ftp:"):
+            url_m = re.match(r"(https?://|ftp://)[^\s<>\[\]\"']+", text[i:])
+            if url_m:
+                flush()
+                url = url_m.group(0)
+                nodes.append(LinkNode(href=url, children=(TextNode(text=url),)))
+                i += len(url)
+                continue
+
         buf += text[i]
         i += 1
 
@@ -1067,7 +1100,16 @@ def _append_content(
 
 def _paragraph_node(token: _ParagraphToken, fn_map: dict[str, int] | None = None) -> Paragraph:
     """Convert a paragraph token into a :class:`~ir.Paragraph` node."""
-    text = " ".join(line.strip() for line in token.lines)
+    # Trailing backslash on a line is a hard line break (CommonMark / pymdownx.escapeall).
+    # Preserve it as <br> so the inline parser can detect it.
+    parts: list[str] = []
+    for line in token.lines:
+        stripped = line.strip()
+        if stripped.endswith("\\"):
+            parts.append(stripped[:-1] + "<br>")
+        else:
+            parts.append(stripped)
+    text = " ".join(parts)
     return Paragraph(children=_parse_inline(text, fn_map=fn_map))
 
 

{mkdocs2confluence-0.6.5 → mkdocs2confluence-0.6.7}/tests/test_emitter.py

@@ -12,6 +12,7 @@ from mkdocs_to_confluence.ir.nodes import (
     ContentTabs,
     Expandable,
     HorizontalRule,
+    InsertNode,
     ItalicNode,
     LinkNode,
     ListItem,
@@ -267,6 +268,10 @@ class TestSubscriptSuperscriptEmitter:
         out = emit((Paragraph((SuperscriptNode((TextNode("2"),)),)),))
         assert "<sup>2</sup>" in out
 
+    def test_insert(self) -> None:
+        out = emit((Paragraph((InsertNode((TextNode("new"),)),)),))
+        assert "<u>new</u>" in out
+
 
 class TestDefinitionListEmitter:
     def test_basic_dl(self) -> None:

{mkdocs2confluence-0.6.5 → mkdocs2confluence-0.6.7}/tests/test_ir.py

@@ -19,6 +19,7 @@ from mkdocs_to_confluence.ir import (
     Expandable,
     HorizontalRule,
     ImageNode,
+    InsertNode,
     IRNode,
     ItalicNode,
     LinkNode,
@@ -192,6 +193,10 @@ class TestInlineNodes:
         node = SuperscriptNode(children=(TextNode(text="2"),))
         assert len(node.children) == 1
 
+    def test_insert_node(self) -> None:
+        node = InsertNode(children=(TextNode(text="new"),))
+        assert len(node.children) == 1
+
     def test_code_inline_node(self) -> None:
         node = CodeInlineNode(code="print()")
         assert node.code == "print()"

{mkdocs2confluence-0.6.5 → mkdocs2confluence-0.6.7}/tests/test_parser.py

@@ -735,6 +735,7 @@ from mkdocs_to_confluence.ir import (  # noqa: E402
     DefinitionList,
     HorizontalRule,
     ImageNode,
+    InsertNode,
     ItalicNode,
     LinkNode,
     OrderedList,
@@ -783,6 +784,37 @@ class TestInlineParsing:
         sup = next(n for n in para.children if isinstance(n, SuperscriptNode))
         assert sup.children[0].text == "2"  # type: ignore[union-attr]
 
+    def test_insert_underline(self) -> None:
+        para = first(parse("^^inserted^^\n"), Paragraph)
+        assert isinstance(para, Paragraph)
+        ins = next(n for n in para.children if isinstance(n, InsertNode))
+        assert ins.children[0].text == "inserted"  # type: ignore[union-attr]
+
+    def test_insert_does_not_consume_superscript(self) -> None:
+        """^^text^^ should produce InsertNode, not two SuperscriptNodes."""
+        para = first(parse("^^hello^^\n"), Paragraph)
+        nodes = [n for n in para.children if isinstance(n, InsertNode)]
+        sup_nodes = [n for n in para.children if isinstance(n, SuperscriptNode)]
+        assert len(nodes) == 1
+        assert len(sup_nodes) == 0
+
+    def test_bare_url_autolink(self) -> None:
+        para = first(parse("See https://example.com for details.\n"), Paragraph)
+        link = next(n for n in para.children if isinstance(n, LinkNode))
+        assert link.href == "https://example.com"
+        assert link.children[0].text == "https://example.com"  # type: ignore[union-attr]
+
+    def test_bare_url_http(self) -> None:
+        para = first(parse("Visit http://example.com today.\n"), Paragraph)
+        link = next(n for n in para.children if isinstance(n, LinkNode))
+        assert link.href == "http://example.com"
+
+    def test_trailing_backslash_hard_break(self) -> None:
+        from mkdocs_to_confluence.ir import LineBreakNode
+        nodes = parse("Line one\\\nLine two\n")
+        para = first(nodes, Paragraph)
+        assert any(isinstance(n, LineBreakNode) for n in para.children)
+
     def test_inline_code(self) -> None:
         para = first(parse("Use `foo()` here.\n"), Paragraph)
         assert isinstance(para, Paragraph)

{mkdocs2confluence-0.6.5 → mkdocs2confluence-0.6.7}/tests/test_publish_pipeline.py

@@ -332,7 +332,7 @@ def test_dry_run_prints_page_list(tmp_path: Path, capsys: pytest.CaptureFixture)
 
     captured = capsys.readouterr()
     assert "Dry run" in captured.out
-    assert "example.atlassian.net" in captured.out
+    assert "example.atlassian.net" in captured.out  # codeql[py/incomplete-url-substring-sanitization]
 
 
 def test_dry_run_no_api_calls(tmp_path: Path, capsys: pytest.CaptureFixture) -> None: