mddoco 2.0.3__tar.gz → 2.1.0__tar.gz

{mddoco-2.0.3/src/mddoco.egg-info → mddoco-2.1.0}/PKG-INFO

@@ -1,7 +1,11 @@
 Metadata-Version: 2.4
 Name: mddoco
-Version: 2.0.3
+Version: 2.1.0
 Summary: Markdown to HTML/PDF document converter
+Author-email: Phil Massyn <phil.massyn@icloud.com>
+Project-URL: Homepage, https://github.com/massyn/mddoco
+Project-URL: Repository, https://github.com/massyn/mddoco
+Project-URL: Issues, https://github.com/massyn/mddoco/issues
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -20,6 +24,8 @@ Dynamic: license-file
 
 A CLI tool that converts markdown files to a single HTML (or future PDF) document.
 
+[![Publish to PyPI](https://github.com/massyn/mddoco/actions/workflows/ci.yml/badge.svg)](https://github.com/massyn/mddoco/actions/workflows/ci.yml) 
+![PyPI Version](https://img.shields.io/pypi/v/mddoco) ![PyPI Downloads](https://img.shields.io/pypi/dd/mddoco)
 ## Installation
 
 ```bash
@@ -85,6 +91,24 @@ mddoco ./docs --title "My Project" --toc --output ./out
 
 All matched markdown files are combined into a single HTML document in the output directory. The filename is derived from the input folder or file name.
 
+## Examples
+
+The [`examples/`](examples/) directory contains four runnable input folders, each
+covering a different feature:
+
+| Folder | Demonstrates |
+|--------|--------------|
+| [`examples/01_basic`](examples/01_basic) | Plain Markdown, file ordering, underscore-excluded files |
+| [`examples/02_rich_content`](examples/02_rich_content) | Mermaid diagrams, syntax highlighting, `graph` charts |
+| [`examples/03_themed_report`](examples/03_themed_report) | Themes and a table of contents |
+| [`examples/04_jinja_data`](examples/04_jinja_data) | Jinja2 templates with JSON and CSV data files |
+
+```bash
+mddoco examples/03_themed_report --theme professional --title "Q3 Platform Review" --toc --output ./out
+```
+
+See [`examples/README.md`](examples/README.md) for the full list of commands.
+
 ## Jinja2 templates
 
 Files ending in `.md.j2` are Jinja2 templates that produce Markdown. They are sorted alongside regular `.md` files (numeric prefixes such as `01_`, `02_` determine order) and converted through the same pipeline.

{mddoco-2.0.3 → mddoco-2.1.0}/README.md

@@ -2,6 +2,8 @@
 
 A CLI tool that converts markdown files to a single HTML (or future PDF) document.
 
+[![Publish to PyPI](https://github.com/massyn/mddoco/actions/workflows/ci.yml/badge.svg)](https://github.com/massyn/mddoco/actions/workflows/ci.yml) 
+![PyPI Version](https://img.shields.io/pypi/v/mddoco) ![PyPI Downloads](https://img.shields.io/pypi/dd/mddoco)
 ## Installation
 
 ```bash
@@ -67,6 +69,24 @@ mddoco ./docs --title "My Project" --toc --output ./out
 
 All matched markdown files are combined into a single HTML document in the output directory. The filename is derived from the input folder or file name.
 
+## Examples
+
+The [`examples/`](examples/) directory contains four runnable input folders, each
+covering a different feature:
+
+| Folder | Demonstrates |
+|--------|--------------|
+| [`examples/01_basic`](examples/01_basic) | Plain Markdown, file ordering, underscore-excluded files |
+| [`examples/02_rich_content`](examples/02_rich_content) | Mermaid diagrams, syntax highlighting, `graph` charts |
+| [`examples/03_themed_report`](examples/03_themed_report) | Themes and a table of contents |
+| [`examples/04_jinja_data`](examples/04_jinja_data) | Jinja2 templates with JSON and CSV data files |
+
+```bash
+mddoco examples/03_themed_report --theme professional --title "Q3 Platform Review" --toc --output ./out
+```
+
+See [`examples/README.md`](examples/README.md) for the full list of commands.
+
 ## Jinja2 templates
 
 Files ending in `.md.j2` are Jinja2 templates that produce Markdown. They are sorted alongside regular `.md` files (numeric prefixes such as `01_`, `02_` determine order) and converted through the same pipeline.

{mddoco-2.0.3 → mddoco-2.1.0}/pyproject.toml

@@ -4,10 +4,13 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "mddoco"
-version = "2.0.3"
+version = "2.1.0"
 description = "Markdown to HTML/PDF document converter"
 readme = "README.md"
 requires-python = ">=3.10"
+authors = [
+    { name = "Phil Massyn", email = "phil.massyn@icloud.com" },
+]
 dependencies = [
     "click>=8.0",
     "markdown>=3.5",
@@ -23,6 +26,11 @@ dev = [
     "ruff>=0.16,<0.17",
 ]
 
+[project.urls]
+Homepage = "https://github.com/massyn/mddoco"
+Repository = "https://github.com/massyn/mddoco"
+Issues = "https://github.com/massyn/mddoco/issues"
+
 [project.scripts]
 mddoco = "mddoco.cli:main"
 

mddoco-2.1.0/src/mddoco/__init__.py

@@ -0,0 +1 @@
+__version__ = "2.1.0"

{mddoco-2.0.3 → mddoco-2.1.0}/src/mddoco/cli.py

@@ -79,6 +79,7 @@ def main(
     sections = [(p, html) for p, html, _ in raw]
     toc_html = combine_toc([t for _, _, t in raw]) if toc else None
     has_mermaid = any('<div class="mermaid">' in html for _, html in sections)
+    has_code = any("<pre><code" in html for _, html in sections)
 
     # Resolve output directory and filename.
     # If output_path has a suffix, treat it as an explicit file path.
@@ -99,6 +100,7 @@ def main(
             toc_html=toc_html or None,
             theme=theme,
             has_mermaid=has_mermaid,
+            has_code=has_code,
         )
     except ValueError as exc:
         raise click.ClickException(str(exc)) from exc

{mddoco-2.0.3 → mddoco-2.1.0}/src/mddoco/renderer.py

@@ -10,6 +10,7 @@ def render_html(
     toc_html: str | None = None,
     theme: str = "default",
     has_mermaid: bool = False,
+    has_code: bool = False,
 ) -> str:
     """Render a full HTML document from (path, html_fragment) pairs."""
     theme_path = Path(theme)
@@ -30,4 +31,5 @@ def render_html(
         toc_html=toc_html,
         sections=sections,
         has_mermaid=has_mermaid,
+        has_code=has_code,
     )

{mddoco-2.0.3 → mddoco-2.1.0}/src/mddoco/themes/academic-wide.html

@@ -150,9 +150,15 @@
             pre { page-break-inside: avoid; }
             h2, h3 { page-break-after: avoid; }
         }
+        pre code.hljs { background: transparent; padding: 0; }
     </style>
+    {% if has_code %}
+    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@highlightjs/cdn-assets@11.12.0/styles/github.min.css" integrity="sha384-eFTL69TLRZTkNfYZOLM+G04821K1qZao/4QLJbet1pP4tcF+fdXq/9CdqAbWRl/L" crossorigin="anonymous">
+    <script src="https://cdn.jsdelivr.net/npm/@highlightjs/cdn-assets@11.12.0/highlight.min.js" integrity="sha384-wjfDDhOPPdjtva8vWBhWeVprSpmxisEu5aYT3q1JyACqXpdKpo3PWZTMVq24MBix" crossorigin="anonymous"></script>
+    <script>hljs.highlightAll();</script>
+    {% endif %}
     {% if has_mermaid %}
-    <script src="https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.min.js"></script>
+    <script src="https://cdn.jsdelivr.net/npm/mermaid@11.17.2/dist/mermaid.min.js" integrity="sha384-EOXBFmc3gx5mb+vn0vPvvGqACToJD24hhacX5Yx+8NUUQrHIle/Qi5Bg9o3zKwW2" crossorigin="anonymous"></script>
     <script>mermaid.initialize({ startOnLoad: true, theme: 'neutral' });</script>
     {% endif %}
 </head>

{mddoco-2.0.3 → mddoco-2.1.0}/src/mddoco/themes/academic.html

@@ -151,9 +151,15 @@
             pre { page-break-inside: avoid; }
             h2, h3 { page-break-after: avoid; }
         }
+        pre code.hljs { background: transparent; padding: 0; }
     </style>
+    {% if has_code %}
+    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@highlightjs/cdn-assets@11.12.0/styles/github.min.css" integrity="sha384-eFTL69TLRZTkNfYZOLM+G04821K1qZao/4QLJbet1pP4tcF+fdXq/9CdqAbWRl/L" crossorigin="anonymous">
+    <script src="https://cdn.jsdelivr.net/npm/@highlightjs/cdn-assets@11.12.0/highlight.min.js" integrity="sha384-wjfDDhOPPdjtva8vWBhWeVprSpmxisEu5aYT3q1JyACqXpdKpo3PWZTMVq24MBix" crossorigin="anonymous"></script>
+    <script>hljs.highlightAll();</script>
+    {% endif %}
     {% if has_mermaid %}
-    <script src="https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.min.js"></script>
+    <script src="https://cdn.jsdelivr.net/npm/mermaid@11.17.2/dist/mermaid.min.js" integrity="sha384-EOXBFmc3gx5mb+vn0vPvvGqACToJD24hhacX5Yx+8NUUQrHIle/Qi5Bg9o3zKwW2" crossorigin="anonymous"></script>
     <script>mermaid.initialize({ startOnLoad: true, theme: 'neutral' });</script>
     {% endif %}
 </head>

{mddoco-2.0.3 → mddoco-2.1.0}/src/mddoco/themes/dark-wide.html

@@ -143,9 +143,15 @@
             text-align: center;
             margin: 1.5em 0;
         }
+        pre code.hljs { background: transparent; padding: 0; }
     </style>
+    {% if has_code %}
+    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@highlightjs/cdn-assets@11.12.0/styles/github-dark.min.css" integrity="sha384-wH75j6z1lH97ZOpMOInqhgKzFkAInZPPSPlZpYKYTOqsaizPvhQZmAtLcPKXpLyH" crossorigin="anonymous">
+    <script src="https://cdn.jsdelivr.net/npm/@highlightjs/cdn-assets@11.12.0/highlight.min.js" integrity="sha384-wjfDDhOPPdjtva8vWBhWeVprSpmxisEu5aYT3q1JyACqXpdKpo3PWZTMVq24MBix" crossorigin="anonymous"></script>
+    <script>hljs.highlightAll();</script>
+    {% endif %}
     {% if has_mermaid %}
-    <script src="https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.min.js"></script>
+    <script src="https://cdn.jsdelivr.net/npm/mermaid@11.17.2/dist/mermaid.min.js" integrity="sha384-EOXBFmc3gx5mb+vn0vPvvGqACToJD24hhacX5Yx+8NUUQrHIle/Qi5Bg9o3zKwW2" crossorigin="anonymous"></script>
     <script>mermaid.initialize({ startOnLoad: true, theme: 'dark' });</script>
     {% endif %}
 </head>

{mddoco-2.0.3 → mddoco-2.1.0}/src/mddoco/themes/dark.html

@@ -144,9 +144,15 @@
             text-align: center;
             margin: 1.5em 0;
         }
+        pre code.hljs { background: transparent; padding: 0; }
     </style>
+    {% if has_code %}
+    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@highlightjs/cdn-assets@11.12.0/styles/github-dark.min.css" integrity="sha384-wH75j6z1lH97ZOpMOInqhgKzFkAInZPPSPlZpYKYTOqsaizPvhQZmAtLcPKXpLyH" crossorigin="anonymous">
+    <script src="https://cdn.jsdelivr.net/npm/@highlightjs/cdn-assets@11.12.0/highlight.min.js" integrity="sha384-wjfDDhOPPdjtva8vWBhWeVprSpmxisEu5aYT3q1JyACqXpdKpo3PWZTMVq24MBix" crossorigin="anonymous"></script>
+    <script>hljs.highlightAll();</script>
+    {% endif %}
     {% if has_mermaid %}
-    <script src="https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.min.js"></script>
+    <script src="https://cdn.jsdelivr.net/npm/mermaid@11.17.2/dist/mermaid.min.js" integrity="sha384-EOXBFmc3gx5mb+vn0vPvvGqACToJD24hhacX5Yx+8NUUQrHIle/Qi5Bg9o3zKwW2" crossorigin="anonymous"></script>
     <script>mermaid.initialize({ startOnLoad: true, theme: 'dark' });</script>
     {% endif %}
 </head>

{mddoco-2.0.3 → mddoco-2.1.0}/src/mddoco/themes/default-wide.html

@@ -124,9 +124,15 @@
             text-align: center;
             margin: 1.5em 0;
         }
+        pre code.hljs { background: transparent; padding: 0; }
     </style>
+    {% if has_code %}
+    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@highlightjs/cdn-assets@11.12.0/styles/github.min.css" integrity="sha384-eFTL69TLRZTkNfYZOLM+G04821K1qZao/4QLJbet1pP4tcF+fdXq/9CdqAbWRl/L" crossorigin="anonymous">
+    <script src="https://cdn.jsdelivr.net/npm/@highlightjs/cdn-assets@11.12.0/highlight.min.js" integrity="sha384-wjfDDhOPPdjtva8vWBhWeVprSpmxisEu5aYT3q1JyACqXpdKpo3PWZTMVq24MBix" crossorigin="anonymous"></script>
+    <script>hljs.highlightAll();</script>
+    {% endif %}
     {% if has_mermaid %}
-    <script src="https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.min.js"></script>
+    <script src="https://cdn.jsdelivr.net/npm/mermaid@11.17.2/dist/mermaid.min.js" integrity="sha384-EOXBFmc3gx5mb+vn0vPvvGqACToJD24hhacX5Yx+8NUUQrHIle/Qi5Bg9o3zKwW2" crossorigin="anonymous"></script>
     <script>mermaid.initialize({ startOnLoad: true, theme: 'default' });</script>
     {% endif %}
 </head>

{mddoco-2.0.3 → mddoco-2.1.0}/src/mddoco/themes/default.html

@@ -125,9 +125,15 @@
             text-align: center;
             margin: 1.5em 0;
         }
+        pre code.hljs { background: transparent; padding: 0; }
     </style>
+    {% if has_code %}
+    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@highlightjs/cdn-assets@11.12.0/styles/github.min.css" integrity="sha384-eFTL69TLRZTkNfYZOLM+G04821K1qZao/4QLJbet1pP4tcF+fdXq/9CdqAbWRl/L" crossorigin="anonymous">
+    <script src="https://cdn.jsdelivr.net/npm/@highlightjs/cdn-assets@11.12.0/highlight.min.js" integrity="sha384-wjfDDhOPPdjtva8vWBhWeVprSpmxisEu5aYT3q1JyACqXpdKpo3PWZTMVq24MBix" crossorigin="anonymous"></script>
+    <script>hljs.highlightAll();</script>
+    {% endif %}
     {% if has_mermaid %}
-    <script src="https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.min.js"></script>
+    <script src="https://cdn.jsdelivr.net/npm/mermaid@11.17.2/dist/mermaid.min.js" integrity="sha384-EOXBFmc3gx5mb+vn0vPvvGqACToJD24hhacX5Yx+8NUUQrHIle/Qi5Bg9o3zKwW2" crossorigin="anonymous"></script>
     <script>mermaid.initialize({ startOnLoad: true, theme: 'default' });</script>
     {% endif %}
 </head>

{mddoco-2.0.3 → mddoco-2.1.0}/src/mddoco/themes/paged-professional.html

@@ -224,10 +224,16 @@
 
         /* ── Mermaid ────────────────────────────────────────────────── */
         .mermaid { text-align: center; margin: 1.5em 0; }
+        pre code.hljs { background: transparent; padding: 0; }
     </style>
-    <script src="https://unpkg.com/pagedjs/dist/paged.polyfill.js"></script>
+    <script src="https://cdn.jsdelivr.net/npm/pagedjs@0.4.3/dist/paged.polyfill.js" integrity="sha384-JkjBt3FPbcQ3WBc3qp+maUIw8YLoZxNNj8H+tn73mljkC1ba8aEPWlgwfCRPpAxV" crossorigin="anonymous"></script>
+    {% if has_code %}
+    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@highlightjs/cdn-assets@11.12.0/styles/github.min.css" integrity="sha384-eFTL69TLRZTkNfYZOLM+G04821K1qZao/4QLJbet1pP4tcF+fdXq/9CdqAbWRl/L" crossorigin="anonymous">
+    <script src="https://cdn.jsdelivr.net/npm/@highlightjs/cdn-assets@11.12.0/highlight.min.js" integrity="sha384-wjfDDhOPPdjtva8vWBhWeVprSpmxisEu5aYT3q1JyACqXpdKpo3PWZTMVq24MBix" crossorigin="anonymous"></script>
+    <script>hljs.highlightAll();</script>
+    {% endif %}
     {% if has_mermaid %}
-    <script src="https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.min.js"></script>
+    <script src="https://cdn.jsdelivr.net/npm/mermaid@11.17.2/dist/mermaid.min.js" integrity="sha384-EOXBFmc3gx5mb+vn0vPvvGqACToJD24hhacX5Yx+8NUUQrHIle/Qi5Bg9o3zKwW2" crossorigin="anonymous"></script>
     <script>mermaid.initialize({ startOnLoad: true, theme: 'neutral' });</script>
     {% endif %}
 </head>

{mddoco-2.0.3 → mddoco-2.1.0}/src/mddoco/themes/professional-wide.html

@@ -182,9 +182,15 @@
 
         /* ── Mermaid ───────────────────────────────────────────────── */
         .mermaid { text-align: center; margin: 1.5em 0; }
+        pre code.hljs { background: transparent; padding: 0; }
     </style>
+    {% if has_code %}
+    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@highlightjs/cdn-assets@11.12.0/styles/github.min.css" integrity="sha384-eFTL69TLRZTkNfYZOLM+G04821K1qZao/4QLJbet1pP4tcF+fdXq/9CdqAbWRl/L" crossorigin="anonymous">
+    <script src="https://cdn.jsdelivr.net/npm/@highlightjs/cdn-assets@11.12.0/highlight.min.js" integrity="sha384-wjfDDhOPPdjtva8vWBhWeVprSpmxisEu5aYT3q1JyACqXpdKpo3PWZTMVq24MBix" crossorigin="anonymous"></script>
+    <script>hljs.highlightAll();</script>
+    {% endif %}
     {% if has_mermaid %}
-    <script src="https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.min.js"></script>
+    <script src="https://cdn.jsdelivr.net/npm/mermaid@11.17.2/dist/mermaid.min.js" integrity="sha384-EOXBFmc3gx5mb+vn0vPvvGqACToJD24hhacX5Yx+8NUUQrHIle/Qi5Bg9o3zKwW2" crossorigin="anonymous"></script>
     <script>mermaid.initialize({ startOnLoad: true, theme: 'neutral' });</script>
     {% endif %}
 </head>

{mddoco-2.0.3 → mddoco-2.1.0}/src/mddoco/themes/professional.html

@@ -182,9 +182,15 @@
 
         /* ── Mermaid ───────────────────────────────────────────────── */
         .mermaid { text-align: center; margin: 1.5em 0; }
+        pre code.hljs { background: transparent; padding: 0; }
     </style>
+    {% if has_code %}
+    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@highlightjs/cdn-assets@11.12.0/styles/github.min.css" integrity="sha384-eFTL69TLRZTkNfYZOLM+G04821K1qZao/4QLJbet1pP4tcF+fdXq/9CdqAbWRl/L" crossorigin="anonymous">
+    <script src="https://cdn.jsdelivr.net/npm/@highlightjs/cdn-assets@11.12.0/highlight.min.js" integrity="sha384-wjfDDhOPPdjtva8vWBhWeVprSpmxisEu5aYT3q1JyACqXpdKpo3PWZTMVq24MBix" crossorigin="anonymous"></script>
+    <script>hljs.highlightAll();</script>
+    {% endif %}
     {% if has_mermaid %}
-    <script src="https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.min.js"></script>
+    <script src="https://cdn.jsdelivr.net/npm/mermaid@11.17.2/dist/mermaid.min.js" integrity="sha384-EOXBFmc3gx5mb+vn0vPvvGqACToJD24hhacX5Yx+8NUUQrHIle/Qi5Bg9o3zKwW2" crossorigin="anonymous"></script>
     <script>mermaid.initialize({ startOnLoad: true, theme: 'neutral' });</script>
     {% endif %}
 </head>

{mddoco-2.0.3 → mddoco-2.1.0}/src/mddoco/themes/vanilla.html

@@ -8,9 +8,15 @@
         table { border-collapse: collapse; }
         th, td { border: 1px solid #999; padding: 0.3em 0.6em; }
         th { background: #eee; }
+        pre code.hljs { background: transparent; padding: 0; }
     </style>
+    {% if has_code %}
+    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@highlightjs/cdn-assets@11.12.0/styles/github.min.css" integrity="sha384-eFTL69TLRZTkNfYZOLM+G04821K1qZao/4QLJbet1pP4tcF+fdXq/9CdqAbWRl/L" crossorigin="anonymous">
+    <script src="https://cdn.jsdelivr.net/npm/@highlightjs/cdn-assets@11.12.0/highlight.min.js" integrity="sha384-wjfDDhOPPdjtva8vWBhWeVprSpmxisEu5aYT3q1JyACqXpdKpo3PWZTMVq24MBix" crossorigin="anonymous"></script>
+    <script>hljs.highlightAll();</script>
+    {% endif %}
     {% if has_mermaid %}
-    <script src="https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.min.js"></script>
+    <script src="https://cdn.jsdelivr.net/npm/mermaid@11.17.2/dist/mermaid.min.js" integrity="sha384-EOXBFmc3gx5mb+vn0vPvvGqACToJD24hhacX5Yx+8NUUQrHIle/Qi5Bg9o3zKwW2" crossorigin="anonymous"></script>
     <script>mermaid.initialize({ startOnLoad: true });</script>
     {% endif %}
 </head>

{mddoco-2.0.3 → mddoco-2.1.0/src/mddoco.egg-info}/PKG-INFO

@@ -1,7 +1,11 @@
 Metadata-Version: 2.4
 Name: mddoco
-Version: 2.0.3
+Version: 2.1.0
 Summary: Markdown to HTML/PDF document converter
+Author-email: Phil Massyn <phil.massyn@icloud.com>
+Project-URL: Homepage, https://github.com/massyn/mddoco
+Project-URL: Repository, https://github.com/massyn/mddoco
+Project-URL: Issues, https://github.com/massyn/mddoco/issues
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -20,6 +24,8 @@ Dynamic: license-file
 
 A CLI tool that converts markdown files to a single HTML (or future PDF) document.
 
+[![Publish to PyPI](https://github.com/massyn/mddoco/actions/workflows/ci.yml/badge.svg)](https://github.com/massyn/mddoco/actions/workflows/ci.yml) 
+![PyPI Version](https://img.shields.io/pypi/v/mddoco) ![PyPI Downloads](https://img.shields.io/pypi/dd/mddoco)
 ## Installation
 
 ```bash
@@ -85,6 +91,24 @@ mddoco ./docs --title "My Project" --toc --output ./out
 
 All matched markdown files are combined into a single HTML document in the output directory. The filename is derived from the input folder or file name.
 
+## Examples
+
+The [`examples/`](examples/) directory contains four runnable input folders, each
+covering a different feature:
+
+| Folder | Demonstrates |
+|--------|--------------|
+| [`examples/01_basic`](examples/01_basic) | Plain Markdown, file ordering, underscore-excluded files |
+| [`examples/02_rich_content`](examples/02_rich_content) | Mermaid diagrams, syntax highlighting, `graph` charts |
+| [`examples/03_themed_report`](examples/03_themed_report) | Themes and a table of contents |
+| [`examples/04_jinja_data`](examples/04_jinja_data) | Jinja2 templates with JSON and CSV data files |
+
+```bash
+mddoco examples/03_themed_report --theme professional --title "Q3 Platform Review" --toc --output ./out
+```
+
+See [`examples/README.md`](examples/README.md) for the full list of commands.
+
 ## Jinja2 templates
 
 Files ending in `.md.j2` are Jinja2 templates that produce Markdown. They are sorted alongside regular `.md` files (numeric prefixes such as `01_`, `02_` determine order) and converted through the same pipeline.

{mddoco-2.0.3 → mddoco-2.1.0}/tests/test_preprocessor.py

@@ -14,7 +14,7 @@ from mddoco.preprocessor import (
 
 
 def test_version():
-    assert mddoco.__version__ == "2.0.3"
+    assert mddoco.__version__ == "2.1.0"
 
 
 # --- _parse_csv_line ---

mddoco-2.0.3/src/mddoco/__init__.py

@@ -1 +0,0 @@
-__version__ = "2.0.3"