mkdocs-md-to-pdf 0.1.0__tar.gz → 0.1.2__tar.gz

{mkdocs_md_to_pdf-0.1.0/src/mkdocs_md_to_pdf.egg-info → mkdocs_md_to_pdf-0.1.2}/PKG-INFO

@@ -1,13 +1,11 @@
 Metadata-Version: 2.4
 Name: mkdocs-md-to-pdf
-Version: 0.1.0
+Version: 0.1.2
 Summary: Convert Markdown files to PDF using MkDocs Material theme and Playwright
+Keywords: markdown,pdf,mkdocs,converter,documentation
+Author: Lode Rosseel
 Author-email: Lode Rosseel <lode.rosseel@cegeka.com>
 License-Expression: MIT
-Project-URL: Homepage, https://github.com/lode-braced/mkdocs-md-to-pdf
-Project-URL: Repository, https://github.com/lode-braced/mkdocs-md-to-pdf
-Project-URL: Issues, https://github.com/lode-braced/mkdocs-md-to-pdf/issues
-Keywords: markdown,pdf,mkdocs,converter,documentation
 Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
@@ -17,19 +15,20 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Documentation
 Classifier: Topic :: Text Processing :: Markup :: Markdown
-Requires-Python: >=3.12
-Description-Content-Type: text/markdown
-License-File: LICENSE
 Requires-Dist: mkdocs>=1.6.1
 Requires-Dist: mkdocs-material>=9.6
 Requires-Dist: playwright>=1.42
 Requires-Dist: pymdown-extensions>=10.14
 Requires-Dist: plantuml-markdown>=3.11
 Requires-Dist: mkdocs-callouts>=1.16
+Requires-Dist: pytest>=8.0 ; extra == 'dev'
+Requires-Dist: pytest-mock>=3.14 ; extra == 'dev'
+Requires-Python: >=3.12
+Project-URL: Homepage, https://github.com/lode-braced/mkdocs-md-to-pdf
+Project-URL: Repository, https://github.com/lode-braced/mkdocs-md-to-pdf
+Project-URL: Issues, https://github.com/lode-braced/mkdocs-md-to-pdf/issues
 Provides-Extra: dev
-Requires-Dist: pytest>=8.0; extra == "dev"
-Requires-Dist: pytest-mock>=3.14; extra == "dev"
-Dynamic: license-file
+Description-Content-Type: text/markdown
 
 # mkdocs-md-to-pdf
 

{mkdocs_md_to_pdf-0.1.0 → mkdocs_md_to_pdf-0.1.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mkdocs-md-to-pdf"
-version = "0.1.0"
+version = "0.1.2"
 description = "Convert Markdown files to PDF using MkDocs Material theme and Playwright"
 readme = "README.md"
 license = "MIT"
@@ -44,5 +44,12 @@ Repository = "https://github.com/lode-braced/mkdocs-md-to-pdf"
 Issues = "https://github.com/lode-braced/mkdocs-md-to-pdf/issues"
 
 
+[build-system]
+requires = ["uv_build>=0.5.15"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-root = "src"
+
 [tool.pytest.ini_options]
 testpaths = ["tests"]

{mkdocs_md_to_pdf-0.1.0 → mkdocs_md_to_pdf-0.1.2}/src/mkdocs_md_to_pdf/cli.py

@@ -14,7 +14,8 @@ def main() -> None:
     )
     parser.add_argument("input_file", help="Path to the markdown file to convert")
     parser.add_argument(
-        "-o", "--output",
+        "-o",
+        "--output",
         help="Output PDF file path (default: write to stdout)",
     )
     args = parser.parse_args()

{mkdocs_md_to_pdf-0.1.0 → mkdocs_md_to_pdf-0.1.2}/src/mkdocs_md_to_pdf/converter.py

@@ -5,6 +5,7 @@ import os
 import re
 import shutil
 import subprocess
+import sys
 import tempfile
 import time
 from pathlib import Path
@@ -14,9 +15,11 @@ from playwright.sync_api import sync_playwright
 
 def _get_template_content() -> str:
     """Load the mkdocs.yml template from package resources."""
-    return importlib.resources.files("mkdocs_md_to_pdf").joinpath(
-        "mkdocs.yml.template"
-    ).read_text()
+    return (
+        importlib.resources.files("mkdocs_md_to_pdf")
+        .joinpath("mkdocs.yml.template")
+        .read_text()
+    )
 
 
 def _create_temp_mkdocs_config(input_file: Path, temp_dir: Path) -> Path:
@@ -36,9 +39,9 @@ def _create_temp_mkdocs_config(input_file: Path, temp_dir: Path) -> Path:
         if linked_file_path.is_file():
             shutil.copy2(linked_file_path, temp_docs_dir)
 
-    config_content = template_content.replace(
-        "{{site_name}}", input_file.name
-    ).replace("{{docs_dir}}", "docs")
+    config_content = template_content.replace("{{site_name}}", input_file.name).replace(
+        "{{docs_dir}}", "docs"
+    )
 
     temp_config_path = temp_dir / "mkdocs.yml"
     temp_config_path.write_text(config_content)
@@ -67,10 +70,13 @@ def _extract_linked_files(input_file: Path) -> list[str]:
 
 def _serve_mkdocs(temp_dir: Path, port: int = 8765) -> subprocess.Popen:
     """Build and serve the mkdocs site."""
-    subprocess.run(["mkdocs", "build"], cwd=temp_dir, check=True, capture_output=True)
+    mkdocs_cmd = [sys.executable, "-m", "mkdocs"]
+    subprocess.run(
+        [*mkdocs_cmd, "build"], cwd=temp_dir, check=True, capture_output=True
+    )
 
     server_process = subprocess.Popen(
-        ["mkdocs", "serve", "-a", f"127.0.0.1:{port}"],
+        [*mkdocs_cmd, "serve", "-a", f"127.0.0.1:{port}"],
         cwd=temp_dir,
         stdout=subprocess.PIPE,
         stderr=subprocess.PIPE,

mkdocs_md_to_pdf-0.1.2/src/mkdocs_md_to_pdf/mkdocs.yml.template

@@ -0,0 +1,44 @@
+site_name: {{site_name}}
+remote_branch: pages
+theme:
+  name: material
+  palette:
+    # Palette toggle for automatic mode
+    - media: "(prefers-color-scheme)"
+      toggle:
+        icon: material/brightness-auto
+        name: Switch to light mode
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      toggle:
+        icon: material/brightness-7
+        name: "Switch to dark mode"
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      toggle:
+        icon: material/brightness-4
+        name: "Switch to System preference"
+  features:
+    - navigation.tabs
+
+
+markdown_extensions:
+  - admonition
+  - pymdownx.details
+  - pymdownx.blocks.caption
+  - pymdownx.superfences:
+      custom_fences:
+        - name: mermaid
+          class: mermaid
+          format: !!python/name:pymdownx.superfences.fence_code_format
+  - pymdownx.details
+  - pymdownx.highlight:
+      pygments_lang_class: true
+  - plantuml_markdown:
+      format: svg
+      cachedir: /tmp/puml
+
+plugins:
+  - callouts
+
+docs_dir: {{docs_dir}}

mkdocs_md_to_pdf-0.1.0/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2025 Lode Rosseel
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

mkdocs_md_to_pdf-0.1.0/PKG-INFO

@@ -1,117 +0,0 @@
-Metadata-Version: 2.4
-Name: mkdocs-md-to-pdf
-Version: 0.1.0
-Summary: Convert Markdown files to PDF using MkDocs Material theme and Playwright
-Author-email: Lode Rosseel <lode.rosseel@cegeka.com>
-License-Expression: MIT
-Project-URL: Homepage, https://github.com/lode-braced/mkdocs-md-to-pdf
-Project-URL: Repository, https://github.com/lode-braced/mkdocs-md-to-pdf
-Project-URL: Issues, https://github.com/lode-braced/mkdocs-md-to-pdf/issues
-Keywords: markdown,pdf,mkdocs,converter,documentation
-Classifier: Development Status :: 4 - Beta
-Classifier: Environment :: Console
-Classifier: Intended Audience :: Developers
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Topic :: Documentation
-Classifier: Topic :: Text Processing :: Markup :: Markdown
-Requires-Python: >=3.12
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: mkdocs>=1.6.1
-Requires-Dist: mkdocs-material>=9.6
-Requires-Dist: playwright>=1.42
-Requires-Dist: pymdown-extensions>=10.14
-Requires-Dist: plantuml-markdown>=3.11
-Requires-Dist: mkdocs-callouts>=1.16
-Provides-Extra: dev
-Requires-Dist: pytest>=8.0; extra == "dev"
-Requires-Dist: pytest-mock>=3.14; extra == "dev"
-Dynamic: license-file
-
-# mkdocs-md-to-pdf
-
-Convert Markdown files to styled PDFs using [MkDocs Material](https://squidfunk.github.io/mkdocs-material/) theme and [Playwright](https://playwright.dev/).
-
-## Features
-
-- Material Design styling via MkDocs Material theme
-- Syntax highlighting for code blocks
-- Mermaid diagram support
-- PlantUML diagram support (requires Java)
-- Admonitions and callouts
-- Automatic handling of linked images and files
-
-## Installation
-
-```bash
-# Using uv
-uv add mkdocs-md-to-pdf
-
-# Using pip
-pip install mkdocs-md-to-pdf
-```
-
-After installation, install the Chromium browser for Playwright:
-
-```bash
-playwright install chromium
-```
-
-### PlantUML Setup
-
-#### macOS
-1. Download PlantUML JAR from [GitHub releases](https://github.com/plantuml/plantuml/releases/latest)
-2. Place JAR: `mv plantuml-mit-1.2025.8.jar ~/.local/bin/plantuml.jar`
-3. Make executable: `chmod +x ~/.local/bin/plantuml.jar`
-4. Add to shell profile (.bashrc/.zshrc):
-```bash
-export PATH="$PATH:~/.local/bin"
-export PATH="/opt/homebrew/opt/openjdk/bin:$PATH"
-```
-
-#### Ubuntu/Debian
-```bash
-sudo apt install default-jdk plantuml
-```
-
-## Usage
-
-### Command Line
-
-```bash
-# Output to stdout (pipe to file)
-md-to-pdf document.md > output.pdf
-
-# Output to specific file
-md-to-pdf document.md -o output.pdf
-```
-
-### Python API
-
-```python
-from mkdocs_md_to_pdf import convert
-
-# Get PDF as bytes
-pdf_bytes = convert("document.md")
-
-# Write directly to file
-convert("document.md", output_file="output.pdf")
-```
-
-## Supported Markdown Features
-
-- Standard Markdown syntax
-- Fenced code blocks with syntax highlighting
-- Tables
-- Admonitions (`!!! note`, `!!! warning`, etc.)
-- Callouts (`> [!NOTE]`, `> [!WARNING]`)
-- Mermaid diagrams
-- PlantUML diagrams
-- Linked images (relative paths)
-
-## License
-
-MIT

mkdocs_md_to_pdf-0.1.0/setup.cfg

@@ -1,4 +0,0 @@
-[egg_info]
-tag_build = 
-tag_date = 0
-

mkdocs_md_to_pdf-0.1.0/src/mkdocs_md_to_pdf.egg-info/SOURCES.txt

@@ -1,13 +0,0 @@
-LICENSE
-README.md
-pyproject.toml
-src/mkdocs_md_to_pdf/__init__.py
-src/mkdocs_md_to_pdf/cli.py
-src/mkdocs_md_to_pdf/converter.py
-src/mkdocs_md_to_pdf.egg-info/PKG-INFO
-src/mkdocs_md_to_pdf.egg-info/SOURCES.txt
-src/mkdocs_md_to_pdf.egg-info/dependency_links.txt
-src/mkdocs_md_to_pdf.egg-info/entry_points.txt
-src/mkdocs_md_to_pdf.egg-info/requires.txt
-src/mkdocs_md_to_pdf.egg-info/top_level.txt
-tests/test_converter.py

mkdocs_md_to_pdf-0.1.0/src/mkdocs_md_to_pdf.egg-info/dependency_links.txt

@@ -1 +0,0 @@
-

mkdocs_md_to_pdf-0.1.0/src/mkdocs_md_to_pdf.egg-info/entry_points.txt

@@ -1,2 +0,0 @@
-[console_scripts]
-md-to-pdf = mkdocs_md_to_pdf.cli:main

mkdocs_md_to_pdf-0.1.0/src/mkdocs_md_to_pdf.egg-info/requires.txt

@@ -1,10 +0,0 @@
-mkdocs>=1.6.1
-mkdocs-material>=9.6
-playwright>=1.42
-pymdown-extensions>=10.14
-plantuml-markdown>=3.11
-mkdocs-callouts>=1.16
-
-[dev]
-pytest>=8.0
-pytest-mock>=3.14

mkdocs_md_to_pdf-0.1.0/src/mkdocs_md_to_pdf.egg-info/top_level.txt

@@ -1 +0,0 @@
-mkdocs_md_to_pdf

mkdocs_md_to_pdf-0.1.0/tests/test_converter.py

@@ -1,48 +0,0 @@
-"""Tests for the converter module."""
-
-import tempfile
-from pathlib import Path
-
-import pytest
-
-from mkdocs_md_to_pdf import __version__, convert
-from mkdocs_md_to_pdf.converter import _extract_linked_files, _get_template_content
-
-
-def test_version():
-    assert __version__ == "0.1.0"
-
-
-def test_get_template_content():
-    content = _get_template_content()
-    assert "{{site_name}}" in content
-    assert "{{docs_dir}}" in content
-    assert "mkdocs-material" in content or "material" in content
-
-
-def test_extract_linked_files():
-    with tempfile.NamedTemporaryFile(mode="w", suffix=".md", delete=False) as f:
-        f.write("""
-# Test Document
-
-![Image](image.png)
-[Link](other.md)
-[External](https://example.com)
-[Anchor](#section)
-<img src="photo.jpg" alt="Photo">
-<img src="https://example.com/img.png" alt="External">
-""")
-        f.flush()
-
-        linked = _extract_linked_files(Path(f.name))
-
-    assert "image.png" in linked
-    assert "other.md" in linked
-    assert "photo.jpg" in linked
-    assert "https://example.com" not in linked
-    assert "#section" not in linked
-
-
-def test_convert_file_not_found():
-    with pytest.raises(FileNotFoundError):
-        convert("/nonexistent/path/to/file.md")