mkdocs2confluence 0.11.0__tar.gz → 0.12.0__tar.gz

mkdocs2confluence-0.12.0/PKG-INFO

@@ -0,0 +1,196 @@
+Metadata-Version: 2.4
+Name: mkdocs2confluence
+Version: 0.12.0
+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
+Project-URL: Homepage, https://github.com/jeckyl2010/mkdocs2confluence
+Project-URL: Repository, https://github.com/jeckyl2010/mkdocs2confluence
+Project-URL: Issues, https://github.com/jeckyl2010/mkdocs2confluence/issues
+Project-URL: Changelog, https://github.com/jeckyl2010/mkdocs2confluence/releases
+Keywords: mkdocs,confluence,atlassian,documentation,publishing,material-for-mkdocs,markdown,storage-format
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Documentation
+Classifier: Topic :: Software Development :: Documentation
+Classifier: Topic :: Text Processing :: Markup
+Classifier: Topic :: Utilities
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PyYAML>=6.0.3
+Requires-Dist: httpx>=0.27
+Requires-Dist: tinycss2>=1.5.1
+Provides-Extra: pdf
+Requires-Dist: weasyprint>=60.0; extra == "pdf"
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: types-PyYAML; extra == "dev"
+Requires-Dist: bandit; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Dynamic: license-file
+
+# 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/)
+[![PyPI](https://img.shields.io/pypi/v/mkdocs2confluence)](https://pypi.org/project/mkdocs2confluence/)
+[![Downloads](https://img.shields.io/pypi/dm/mkdocs2confluence)](https://pypi.org/project/mkdocs2confluence/)
+[![Latest Release](https://img.shields.io/github/v/release/jeckyl2010/mkdocs2confluence)](https://github.com/jeckyl2010/mkdocs2confluence/releases/latest)
+[![CI](https://github.com/jeckyl2010/mkdocs2confluence/actions/workflows/ci.yml/badge.svg)](https://github.com/jeckyl2010/mkdocs2confluence/actions/workflows/ci.yml)
+[![Release](https://github.com/jeckyl2010/mkdocs2confluence/actions/workflows/release.yml/badge.svg)](https://github.com/jeckyl2010/mkdocs2confluence/actions/workflows/release.yml)
+[![codecov](https://codecov.io/gh/jeckyl2010/mkdocs2confluence/graph/badge.svg)](https://codecov.io/gh/jeckyl2010/mkdocs2confluence)
+[![Ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)
+[![mypy](https://img.shields.io/badge/type--checked-mypy-blue.svg)](https://mypy-lang.org/)
+[![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)
+[![SLSA Level 3](https://slsa.dev/images/gh-badge-level3.svg)](https://slsa.dev)
+[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/jeckyl2010/mkdocs2confluence/badge)](https://securityscorecards.dev/viewer/?uri=github.com/jeckyl2010/mkdocs2confluence)
+
+A Python CLI tool that compiles MkDocs-flavoured Markdown into **native Confluence storage XHTML** and publishes it directly to Confluence Cloud. It is a **compiler/transpiler**, not an HTML converter — every construct maps to its native Confluence equivalent, so pages look and behave like hand-authored Confluence content.
+
+It also bridges the gap between Confluence reviewers and developers: the `sync-comments` command turns open Confluence page comments into GitHub pull request review threads, and auto-resolves them in Confluence when the PR is merged.
+
+> **Zensical compatible** — [Zensical](https://zensical.org/) is the modern successor to MkDocs + Material for MkDocs. Since it uses the same `mkdocs.yml` format and Python Markdown extensions, your Zensical project works with mk2conf today with no changes required.
+
+---
+
+## Installation
+
+Requires Python 3.12+. The PyPI package is `mkdocs2confluence`; the CLI command is `mk2conf`.
+
+```bash
+pip install mkdocs2confluence
+# or, for an isolated install:
+pipx install mkdocs2confluence
+```
+
+**From source** (see [Setup.md](Setup.md)):
+
+```bash
+git clone https://github.com/jeckyl2010/mkdocs2confluence.git
+cd mkdocs2confluence && uv sync
+```
+
+---
+
+## GitHub Actions
+
+Publish docs automatically on every push — no local install needed:
+
+```yaml
+- name: Publish docs to Confluence
+  uses: jeckyl2010/mkdocs2confluence@v1
+  with:
+    token: ${{ secrets.CONFLUENCE_API_TOKEN }}
+```
+
+**Full workflow** — triggers on changes to `docs/` or `mkdocs.yml`:
+
+```yaml
+name: Publish docs
+
+on:
+  push:
+    branches: [main]
+    paths: ['docs/**', 'mkdocs.yml']
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: jeckyl2010/mkdocs2confluence@v1
+        with:
+          token: ${{ secrets.CONFLUENCE_API_TOKEN }}
+          prune: 'true'
+```
+
+Available inputs: `token` (required), `config`, `version`, `dry-run`, `section`, `page`, `prune`, `quiet`. See [docs/commands.md](docs/commands.md) for details.
+
+---
+
+## Quick start
+
+```bash
+# Preview a page locally (no Confluence API calls)
+mk2conf preview --page index.md --watch
+
+# Dry-run: see what would be published
+mk2conf publish --dry-run
+
+# Publish all nav pages
+mk2conf publish
+
+# Export a section to PDF
+mk2conf pdf --section Guide --out guide.pdf
+
+# Sync Confluence comments to GitHub PR review threads
+mk2conf sync-comments
+```
+
+---
+
+## Configuration
+
+Add a `confluence:` block to your `mkdocs.yml`:
+
+```yaml
+confluence:
+  base_url: https://yourorg.atlassian.net
+  space_key: TECH
+  email: user@example.com
+  token: !ENV CONFLUENCE_API_TOKEN   # never hardcode the token
+  parent_page_id: "123456"           # optional root page
+  mermaid_render: kroki              # "kroki" (default) | "kroki:https://your-kroki" | "none"
+  full_width: true                   # default: true
+```
+
+The `confluence:` block is also accepted under `extra:` for MkDocs strict-mode compatibility. The API token is read from `token:` in `mkdocs.yml`, then `CONFLUENCE_API_TOKEN`, then `MK2CONF_TOKEN`.
+
+**Your first publish:**
+
+```bash
+export CONFLUENCE_API_TOKEN=your_api_token_here
+mk2conf preview --page docs/index.md --watch   # verify output locally
+mk2conf publish --dry-run                       # check the plan
+mk2conf publish                                 # go live
+```
+
+---
+
+## Documentation
+
+| | |
+|---|---|
+| [docs/commands.md](docs/commands.md) | Full flag reference for all four commands |
+| [docs/features.md](docs/features.md) | Supported Markdown / Material features and known limitations |
+| [Setup.md](Setup.md) | Development environment setup |
+
+---
+
+## Architecture
+
+![Architecture](https://raw.githubusercontent.com/jeckyl2010/mkdocs2confluence/main/docs/architecture.png)
+
+Pipeline stages: **loader → preprocess → IR → transforms → emitter → publisher**. The plan phase makes all API read calls; the execute phase makes all write calls in nav order so parent pages always exist before their children.
+
+---
+
+## Development
+
+```bash
+uv run pytest -q
+uv run ruff check src tests
+uv run mypy src
+uv run vulture src --min-confidence 80
+```
+

mkdocs2confluence-0.12.0/README.md

@@ -0,0 +1,155 @@
+# 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/)
+[![PyPI](https://img.shields.io/pypi/v/mkdocs2confluence)](https://pypi.org/project/mkdocs2confluence/)
+[![Downloads](https://img.shields.io/pypi/dm/mkdocs2confluence)](https://pypi.org/project/mkdocs2confluence/)
+[![Latest Release](https://img.shields.io/github/v/release/jeckyl2010/mkdocs2confluence)](https://github.com/jeckyl2010/mkdocs2confluence/releases/latest)
+[![CI](https://github.com/jeckyl2010/mkdocs2confluence/actions/workflows/ci.yml/badge.svg)](https://github.com/jeckyl2010/mkdocs2confluence/actions/workflows/ci.yml)
+[![Release](https://github.com/jeckyl2010/mkdocs2confluence/actions/workflows/release.yml/badge.svg)](https://github.com/jeckyl2010/mkdocs2confluence/actions/workflows/release.yml)
+[![codecov](https://codecov.io/gh/jeckyl2010/mkdocs2confluence/graph/badge.svg)](https://codecov.io/gh/jeckyl2010/mkdocs2confluence)
+[![Ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)
+[![mypy](https://img.shields.io/badge/type--checked-mypy-blue.svg)](https://mypy-lang.org/)
+[![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)
+[![SLSA Level 3](https://slsa.dev/images/gh-badge-level3.svg)](https://slsa.dev)
+[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/jeckyl2010/mkdocs2confluence/badge)](https://securityscorecards.dev/viewer/?uri=github.com/jeckyl2010/mkdocs2confluence)
+
+A Python CLI tool that compiles MkDocs-flavoured Markdown into **native Confluence storage XHTML** and publishes it directly to Confluence Cloud. It is a **compiler/transpiler**, not an HTML converter — every construct maps to its native Confluence equivalent, so pages look and behave like hand-authored Confluence content.
+
+It also bridges the gap between Confluence reviewers and developers: the `sync-comments` command turns open Confluence page comments into GitHub pull request review threads, and auto-resolves them in Confluence when the PR is merged.
+
+> **Zensical compatible** — [Zensical](https://zensical.org/) is the modern successor to MkDocs + Material for MkDocs. Since it uses the same `mkdocs.yml` format and Python Markdown extensions, your Zensical project works with mk2conf today with no changes required.
+
+---
+
+## Installation
+
+Requires Python 3.12+. The PyPI package is `mkdocs2confluence`; the CLI command is `mk2conf`.
+
+```bash
+pip install mkdocs2confluence
+# or, for an isolated install:
+pipx install mkdocs2confluence
+```
+
+**From source** (see [Setup.md](Setup.md)):
+
+```bash
+git clone https://github.com/jeckyl2010/mkdocs2confluence.git
+cd mkdocs2confluence && uv sync
+```
+
+---
+
+## GitHub Actions
+
+Publish docs automatically on every push — no local install needed:
+
+```yaml
+- name: Publish docs to Confluence
+  uses: jeckyl2010/mkdocs2confluence@v1
+  with:
+    token: ${{ secrets.CONFLUENCE_API_TOKEN }}
+```
+
+**Full workflow** — triggers on changes to `docs/` or `mkdocs.yml`:
+
+```yaml
+name: Publish docs
+
+on:
+  push:
+    branches: [main]
+    paths: ['docs/**', 'mkdocs.yml']
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: jeckyl2010/mkdocs2confluence@v1
+        with:
+          token: ${{ secrets.CONFLUENCE_API_TOKEN }}
+          prune: 'true'
+```
+
+Available inputs: `token` (required), `config`, `version`, `dry-run`, `section`, `page`, `prune`, `quiet`. See [docs/commands.md](docs/commands.md) for details.
+
+---
+
+## Quick start
+
+```bash
+# Preview a page locally (no Confluence API calls)
+mk2conf preview --page index.md --watch
+
+# Dry-run: see what would be published
+mk2conf publish --dry-run
+
+# Publish all nav pages
+mk2conf publish
+
+# Export a section to PDF
+mk2conf pdf --section Guide --out guide.pdf
+
+# Sync Confluence comments to GitHub PR review threads
+mk2conf sync-comments
+```
+
+---
+
+## Configuration
+
+Add a `confluence:` block to your `mkdocs.yml`:
+
+```yaml
+confluence:
+  base_url: https://yourorg.atlassian.net
+  space_key: TECH
+  email: user@example.com
+  token: !ENV CONFLUENCE_API_TOKEN   # never hardcode the token
+  parent_page_id: "123456"           # optional root page
+  mermaid_render: kroki              # "kroki" (default) | "kroki:https://your-kroki" | "none"
+  full_width: true                   # default: true
+```
+
+The `confluence:` block is also accepted under `extra:` for MkDocs strict-mode compatibility. The API token is read from `token:` in `mkdocs.yml`, then `CONFLUENCE_API_TOKEN`, then `MK2CONF_TOKEN`.
+
+**Your first publish:**
+
+```bash
+export CONFLUENCE_API_TOKEN=your_api_token_here
+mk2conf preview --page docs/index.md --watch   # verify output locally
+mk2conf publish --dry-run                       # check the plan
+mk2conf publish                                 # go live
+```
+
+---
+
+## Documentation
+
+| | |
+|---|---|
+| [docs/commands.md](docs/commands.md) | Full flag reference for all four commands |
+| [docs/features.md](docs/features.md) | Supported Markdown / Material features and known limitations |
+| [Setup.md](Setup.md) | Development environment setup |
+
+---
+
+## Architecture
+
+![Architecture](https://raw.githubusercontent.com/jeckyl2010/mkdocs2confluence/main/docs/architecture.png)
+
+Pipeline stages: **loader → preprocess → IR → transforms → emitter → publisher**. The plan phase makes all API read calls; the execute phase makes all write calls in nav order so parent pages always exist before their children.
+
+---
+
+## Development
+
+```bash
+uv run pytest -q
+uv run ruff check src tests
+uv run mypy src
+uv run vulture src --min-confidence 80
+```
+

{mkdocs2confluence-0.11.0 → mkdocs2confluence-0.12.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mkdocs2confluence"
-version = "0.11.0"
+version = "0.12.0"
 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.12.0/src/mkdocs2confluence.egg-info/PKG-INFO

@@ -0,0 +1,196 @@
+Metadata-Version: 2.4
+Name: mkdocs2confluence
+Version: 0.12.0
+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
+Project-URL: Homepage, https://github.com/jeckyl2010/mkdocs2confluence
+Project-URL: Repository, https://github.com/jeckyl2010/mkdocs2confluence
+Project-URL: Issues, https://github.com/jeckyl2010/mkdocs2confluence/issues
+Project-URL: Changelog, https://github.com/jeckyl2010/mkdocs2confluence/releases
+Keywords: mkdocs,confluence,atlassian,documentation,publishing,material-for-mkdocs,markdown,storage-format
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Documentation
+Classifier: Topic :: Software Development :: Documentation
+Classifier: Topic :: Text Processing :: Markup
+Classifier: Topic :: Utilities
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PyYAML>=6.0.3
+Requires-Dist: httpx>=0.27
+Requires-Dist: tinycss2>=1.5.1
+Provides-Extra: pdf
+Requires-Dist: weasyprint>=60.0; extra == "pdf"
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: types-PyYAML; extra == "dev"
+Requires-Dist: bandit; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Dynamic: license-file
+
+# 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/)
+[![PyPI](https://img.shields.io/pypi/v/mkdocs2confluence)](https://pypi.org/project/mkdocs2confluence/)
+[![Downloads](https://img.shields.io/pypi/dm/mkdocs2confluence)](https://pypi.org/project/mkdocs2confluence/)
+[![Latest Release](https://img.shields.io/github/v/release/jeckyl2010/mkdocs2confluence)](https://github.com/jeckyl2010/mkdocs2confluence/releases/latest)
+[![CI](https://github.com/jeckyl2010/mkdocs2confluence/actions/workflows/ci.yml/badge.svg)](https://github.com/jeckyl2010/mkdocs2confluence/actions/workflows/ci.yml)
+[![Release](https://github.com/jeckyl2010/mkdocs2confluence/actions/workflows/release.yml/badge.svg)](https://github.com/jeckyl2010/mkdocs2confluence/actions/workflows/release.yml)
+[![codecov](https://codecov.io/gh/jeckyl2010/mkdocs2confluence/graph/badge.svg)](https://codecov.io/gh/jeckyl2010/mkdocs2confluence)
+[![Ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)
+[![mypy](https://img.shields.io/badge/type--checked-mypy-blue.svg)](https://mypy-lang.org/)
+[![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)
+[![SLSA Level 3](https://slsa.dev/images/gh-badge-level3.svg)](https://slsa.dev)
+[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/jeckyl2010/mkdocs2confluence/badge)](https://securityscorecards.dev/viewer/?uri=github.com/jeckyl2010/mkdocs2confluence)
+
+A Python CLI tool that compiles MkDocs-flavoured Markdown into **native Confluence storage XHTML** and publishes it directly to Confluence Cloud. It is a **compiler/transpiler**, not an HTML converter — every construct maps to its native Confluence equivalent, so pages look and behave like hand-authored Confluence content.
+
+It also bridges the gap between Confluence reviewers and developers: the `sync-comments` command turns open Confluence page comments into GitHub pull request review threads, and auto-resolves them in Confluence when the PR is merged.
+
+> **Zensical compatible** — [Zensical](https://zensical.org/) is the modern successor to MkDocs + Material for MkDocs. Since it uses the same `mkdocs.yml` format and Python Markdown extensions, your Zensical project works with mk2conf today with no changes required.
+
+---
+
+## Installation
+
+Requires Python 3.12+. The PyPI package is `mkdocs2confluence`; the CLI command is `mk2conf`.
+
+```bash
+pip install mkdocs2confluence
+# or, for an isolated install:
+pipx install mkdocs2confluence
+```
+
+**From source** (see [Setup.md](Setup.md)):
+
+```bash
+git clone https://github.com/jeckyl2010/mkdocs2confluence.git
+cd mkdocs2confluence && uv sync
+```
+
+---
+
+## GitHub Actions
+
+Publish docs automatically on every push — no local install needed:
+
+```yaml
+- name: Publish docs to Confluence
+  uses: jeckyl2010/mkdocs2confluence@v1
+  with:
+    token: ${{ secrets.CONFLUENCE_API_TOKEN }}
+```
+
+**Full workflow** — triggers on changes to `docs/` or `mkdocs.yml`:
+
+```yaml
+name: Publish docs
+
+on:
+  push:
+    branches: [main]
+    paths: ['docs/**', 'mkdocs.yml']
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: jeckyl2010/mkdocs2confluence@v1
+        with:
+          token: ${{ secrets.CONFLUENCE_API_TOKEN }}
+          prune: 'true'
+```
+
+Available inputs: `token` (required), `config`, `version`, `dry-run`, `section`, `page`, `prune`, `quiet`. See [docs/commands.md](docs/commands.md) for details.
+
+---
+
+## Quick start
+
+```bash
+# Preview a page locally (no Confluence API calls)
+mk2conf preview --page index.md --watch
+
+# Dry-run: see what would be published
+mk2conf publish --dry-run
+
+# Publish all nav pages
+mk2conf publish
+
+# Export a section to PDF
+mk2conf pdf --section Guide --out guide.pdf
+
+# Sync Confluence comments to GitHub PR review threads
+mk2conf sync-comments
+```
+
+---
+
+## Configuration
+
+Add a `confluence:` block to your `mkdocs.yml`:
+
+```yaml
+confluence:
+  base_url: https://yourorg.atlassian.net
+  space_key: TECH
+  email: user@example.com
+  token: !ENV CONFLUENCE_API_TOKEN   # never hardcode the token
+  parent_page_id: "123456"           # optional root page
+  mermaid_render: kroki              # "kroki" (default) | "kroki:https://your-kroki" | "none"
+  full_width: true                   # default: true
+```
+
+The `confluence:` block is also accepted under `extra:` for MkDocs strict-mode compatibility. The API token is read from `token:` in `mkdocs.yml`, then `CONFLUENCE_API_TOKEN`, then `MK2CONF_TOKEN`.
+
+**Your first publish:**
+
+```bash
+export CONFLUENCE_API_TOKEN=your_api_token_here
+mk2conf preview --page docs/index.md --watch   # verify output locally
+mk2conf publish --dry-run                       # check the plan
+mk2conf publish                                 # go live
+```
+
+---
+
+## Documentation
+
+| | |
+|---|---|
+| [docs/commands.md](docs/commands.md) | Full flag reference for all four commands |
+| [docs/features.md](docs/features.md) | Supported Markdown / Material features and known limitations |
+| [Setup.md](Setup.md) | Development environment setup |
+
+---
+
+## Architecture
+
+![Architecture](https://raw.githubusercontent.com/jeckyl2010/mkdocs2confluence/main/docs/architecture.png)
+
+Pipeline stages: **loader → preprocess → IR → transforms → emitter → publisher**. The plan phase makes all API read calls; the execute phase makes all write calls in nav order so parent pages always exist before their children.
+
+---
+
+## Development
+
+```bash
+uv run pytest -q
+uv run ruff check src tests
+uv run mypy src
+uv run vulture src --min-confidence 80
+```
+

{mkdocs2confluence-0.11.0 → mkdocs2confluence-0.12.0}/src/mkdocs2confluence.egg-info/SOURCES.txt

@@ -37,6 +37,7 @@ src/mkdocs_to_confluence/preview/render.py
 src/mkdocs_to_confluence/preview/server.py
 src/mkdocs_to_confluence/publisher/__init__.py
 src/mkdocs_to_confluence/publisher/client.py
+src/mkdocs_to_confluence/publisher/http_retry.py
 src/mkdocs_to_confluence/publisher/pipeline.py
 src/mkdocs_to_confluence/sync/__init__.py
 src/mkdocs_to_confluence/sync/anchoring.py

{mkdocs2confluence-0.11.0 → mkdocs2confluence-0.12.0}/src/mkdocs_to_confluence/loader/config.py

@@ -33,6 +33,7 @@ class ConfluenceConfig:
     github_repo: str | None = None          # "owner/repo" — required for sync-comments
     github_token: str | None = None         # GitHub PAT (falls back to GITHUB_TOKEN env var)
     github_base_branch: str = "main"        # base branch for review PRs
+    allow_any_host: bool = False  # set True to allow non-Atlassian Cloud base_url hosts
 
 
 @dataclass(frozen=True)
@@ -209,6 +210,29 @@ def load_config(mkdocs_yml: Path) -> MkDocsConfig:
         if not isinstance(base_url, str) or not base_url.strip():
             raise ConfigError("mkdocs.yml: 'confluence.base_url' is required and must be a non-empty string.")
 
+        # Security: require HTTPS so credentials are never sent in plaintext.
+        parsed_url = urlparse(base_url.strip())
+        if parsed_url.scheme != "https":
+            raise ConfigError(
+                "mkdocs.yml: 'confluence.base_url' must use HTTPS (got "
+                f"{parsed_url.scheme!r}). Plain HTTP would transmit credentials in "
+                "cleartext."
+            )
+
+        allow_any_host = bool(raw_conf.get("allow_any_host", False))
+
+        # Security: guard against a repo-controlled base_url redirecting credentials
+        # to an attacker host.  Non-Atlassian Cloud hosts require an explicit opt-in.
+        host = parsed_url.hostname or ""
+        _is_atlassian = host == "atlassian.net" or host.endswith(".atlassian.net")
+        if not _is_atlassian and not allow_any_host:
+            raise ConfigError(
+                f"mkdocs.yml: 'confluence.base_url' host {host!r} is not an "
+                "Atlassian Cloud domain (*.atlassian.net). If you are using a "
+                "self-hosted Confluence instance, add 'allow_any_host: true' under "
+                "the 'confluence:' block to acknowledge this."
+            )
+
         space_key: str | None = raw_conf.get("space_key") or None
         if space_key:
             space_key = space_key.strip() or None
@@ -248,6 +272,7 @@ def load_config(mkdocs_yml: Path) -> MkDocsConfig:
             github_token=(str(raw_conf["github_token"]) if raw_conf.get("github_token")
                           else os.environ.get("GITHUB_TOKEN") or None),
             github_base_branch=str(raw_conf.get("github_base_branch", "main")),
+            allow_any_host=allow_any_host,
         )
 
     # --- extra_css (optional) ---

{mkdocs2confluence-0.11.0 → mkdocs2confluence-0.12.0}/src/mkdocs_to_confluence/loader/nav.py

@@ -220,7 +220,14 @@ def _traverse(nav: list[Any], docs_dir: Path, level: int, nav_file: str = ".page
         elif isinstance(value, str):
             # Could be a page file or a directory reference (awesome-pages style)
             target = (docs_dir / value).resolve()
-            if target.is_dir():
+            docs_root = docs_dir.resolve()
+            if not target.is_relative_to(docs_root):
+                warnings.warn(
+                    f"Nav page '{title}' resolves outside docs_dir ('{target}') — "
+                    "it will be omitted from the resolved nav.",
+                    stacklevel=4,
+                )
+            elif target.is_dir():
                 children = _resolve_nav_dir(target, docs_dir, level + 1, nav_file)
                 nodes.append(
                     NavNode(