markdown-to-confluence 0.4.0__py3-none-any.whl → 0.4.2__py3-none-any.whl

{markdown_to_confluence-0.4.0.dist-info → markdown_to_confluence-0.4.2.dist-info}/METADATA

@@ -1,15 +1,16 @@
 Metadata-Version: 2.4
 Name: markdown-to-confluence
-Version: 0.4.0
+Version: 0.4.2
 Summary: Publish Markdown files to Confluence wiki
-Home-page: https://github.com/hunyadi/md2conf
-Author: Levente Hunyadi
-Author-email: hunyadi@gmail.com
-License: MIT
+Author-email: Levente Hunyadi <hunyadi@gmail.com>
+Maintainer-email: Levente Hunyadi <hunyadi@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/hunyadi/md2conf
+Project-URL: Source, https://github.com/hunyadi/md2conf
+Keywords: markdown,converter,confluence
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Intended Audience :: End Users/Desktop
-Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
@@ -17,21 +18,26 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Typing :: Typed
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: json_strong_typing>=0.3.9
-Requires-Dist: lxml>=5.4
-Requires-Dist: types-lxml>=2025.3.30
+Requires-Dist: lxml>=6.0
 Requires-Dist: markdown>=3.8
-Requires-Dist: types-markdown>=3.8
 Requires-Dist: pymdown-extensions>=10.16
 Requires-Dist: PyYAML>=6.0
-Requires-Dist: types-PyYAML>=6.0
 Requires-Dist: requests>=2.32
-Requires-Dist: types-requests>=2.32
 Requires-Dist: typing_extensions>=4.14; python_version < "3.12"
+Provides-Extra: dev
+Requires-Dist: markdown_doc>=0.1.4; python_version >= "3.10" and extra == "dev"
+Requires-Dist: types-lxml>=2025.3.30; extra == "dev"
+Requires-Dist: types-markdown>=3.8; extra == "dev"
+Requires-Dist: types-PyYAML>=6.0; extra == "dev"
+Requires-Dist: types-requests>=2.32; extra == "dev"
+Requires-Dist: mypy>=1.16; extra == "dev"
+Requires-Dist: ruff>=0.12; extra == "dev"
 Dynamic: license-file
 
 # Publish Markdown files to Confluence wiki
@@ -52,16 +58,19 @@ This Python package
 * Text with **bold**, *italic*, `monospace`, <ins>underline</ins> and ~~strikethrough~~
 * Link to [sections on the same page](#getting-started) or [external locations](http://example.com/)
 * Subscript and superscript (with HTML tags `<sub>` and `<sup>`)
+* Math formulas with LaTeX notation [^math]
 * Emoji
 * Ordered and unordered lists
 * Block quotes
 * Code blocks (e.g. Python, JSON, XML)
 * Images (uploaded as Confluence page attachments or hosted externally)
 * Tables
+* Footnotes
 * [Table of contents](https://docs.gitlab.com/ee/user/markdown.html#table-of-contents)
 * [Admonitions](https://python-markdown.github.io/extensions/admonition/) and alert boxes in [GitHub](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts) and [GitLab](https://docs.gitlab.com/ee/development/documentation/styleguide/#alert-boxes)
 * [Collapsed sections](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-collapsed-sections)
-* [Mermaid diagrams](https://mermaid.live/) in code blocks (converted to images)
+* draw\.io diagrams [^drawio]
+* [Mermaid diagrams](https://mermaid.live/) in code blocks (converted to images) [^mermaid]
 
 Whenever possible, the implementation uses [Confluence REST API v2](https://developer.atlassian.com/cloud/confluence/rest/v2/) to fetch space properties, and get, create or update page content.
 
@@ -73,12 +82,26 @@ Whenever possible, the implementation uses [Confluence REST API v2](https://deve
 pip install markdown-to-confluence
 ```
 
-**Optional.** Converting code blocks of Mermaid diagrams into Confluence image attachments requires [mermaid-cli](https://github.com/mermaid-js/mermaid-cli):
+### Command-line utilities
+
+**Optional.** Converting `*.drawio` diagrams into PNG or SVG images requires installing [draw.io](https://www.drawio.com/). (Refer to `--render-drawio`.)
+
+**Optional.** Converting code blocks of Mermaid diagrams into PNG or SVG images requires [mermaid-cli](https://github.com/mermaid-js/mermaid-cli). (Refer to `--render-mermaid`.)
 
 ```sh
 npm install -g @mermaid-js/mermaid-cli
 ```
 
+### Marketplace apps
+
+As authors of *md2conf*, we don't endorse or support any particular Confluence marketplace apps.
+
+**Optional.** Editable draw\.io diagrams require [draw.io Diagrams marketplace app](https://marketplace.atlassian.com/apps/1210933/draw-io-diagrams-uml-bpmn-aws-erd-flowcharts). (Refer to `--no-render-drawio`.)
+
+**Optional.** Displaying Mermaid diagrams in Confluence without pre-rendering requires a marketplace app. (Refer to `--no-render-mermaid`.)
+
+**Optional.** Displaying formulas and equations requires [LaTeX Math marketplace app](https://marketplace.atlassian.com/apps/1226109/latex-math-for-confluence-math-formula-equations).
+
 ## Getting started
 
 In order to get started, you will need
@@ -146,7 +169,7 @@ If you lack appropriate permissions, you will get an *Unauthorized* response fro
 Each Markdown file is associated with a Confluence wiki page with a Markdown comment:
 
 ```markdown
-<!-- confluence-page-id: 85668266616 -->
+<!-- confluence-page-id: 20250001023 -->
 ```
 
 The above tells the tool to synchronize the Markdown file with the given Confluence page ID. This implies that the Confluence wiki page must exist such that it has an ID. The comment can be placed anywhere in the source file.
@@ -187,24 +210,28 @@ First, *md2conf* builds an index of pages in the directory hierarchy. The index
 
 If a Markdown file doesn't yet pair up with a Confluence page, *md2conf* creates a new page and assigns a parent. Parent-child relationships are reflected in the navigation panel in Confluence. You can set a root page ID with the command-line option `-r`, which constitutes the topmost parent. (This could correspond to the landing page of your Confluence space. The Confluence page ID is always revealed when you edit a page.) Whenever a directory contains the file `index.md` or `README.md`, this page becomes the future parent page, and all Markdown files in this directory (and possibly nested directories) become its child pages (unless they already have a page ID). However, if an `index.md` or `README.md` file is subsequently found in one of the nested directories, it becomes the parent page of that directory, and any of its subdirectories.
 
+The top-level directory to be synchronized must always have an `index.md` or `README.md`, which maps to the root of the corresponding sub-tree in Confluence (specified with `-r`).
+
 The concepts above are illustrated in the following sections.
 
 #### File-system directory hierarchy
 
-The title of each Markdown file (either the text of the topmost unique heading (`#`), or the title specified in front-matter) is shown next to the file name.
+The title of each Markdown file (either the text of the topmost unique heading (`#`), or the title specified in front-matter) is shown next to the file name. `docs` is the top-level directory to be synchronized.
 
 ```
-.
+docs
+├── index.md: Root page
 ├── computer-science
 │   ├── index.md: Introduction to computer science
 │   ├── algebra.md: Linear algebra
 │   └── algorithms.md: Theory of algorithms
-└── machine-learning
-    ├── README.md: AI and ML
-    ├── awareness.md: Consciousness and intelligence
-    └── statistics
-        ├── index.md: Introduction to statistics
-        └── median.md: Mean vs. median
+├── machine-learning
+│   ├── README.md: AI and ML
+│   ├── awareness.md: Consciousness and intelligence
+│   └── statistics
+│       ├── index.md: Introduction to statistics
+│       └── median.md: Mean vs. median
+└── ethics.md: Ethical considerations
 ```
 
 #### Page hierarchy in Confluence
@@ -212,14 +239,15 @@ The title of each Markdown file (either the text of the topmost unique heading (
 Observe how `index.md` and `README.md` files have assumed parent (or ancestor) role for any Markdown files in the same directory (or below).
 
 ```
-root
+Root page
 ├── Introduction to computer science
 │   ├── Linear algebra
 │   └── Theory of algorithms
-└── AI and ML
-    ├── Consciousness and intelligence
-    └── Introduction to statistics
-        └── Mean vs. median
+├── AI and ML
+│   ├── Consciousness and intelligence
+│   └── Introduction to statistics
+│       └── Mean vs. median
+└── Ethical considerations
 ```
 
 ### Emoji
@@ -293,6 +321,25 @@ Unfortunately, Confluence struggles with SVG images, e.g. they may only show in
 
 External images referenced with an absolute URL retain the original URL.
 
+### LaTeX math formulas
+
+Inline formulas can be enclosed with `$` signs, or delimited with `\(` and `\)`, i.e.
+
+* the code `$\sum_{i=1}^{n} i = \frac{n(n+1)}{2}$` is shown as $\sum_{i=1}^{n} i = \frac{n(n+1)}{2}$,
+* and `\(\lim _{x\rightarrow \infty }\frac{1}{x}=0\)` is shown as $\lim _{x\rightarrow \infty }\frac{1}{x}=0$.
+
+Block formulas can be enclosed with `$$`, or wrapped in code blocks specifying the language `math`:
+
+```md
+$$\int _{a}^{b}f(x)dx=F(b)-F(a)$$
+```
+
+is shown as
+
+$$\int _{a}^{b}f(x)dx=F(b)-F(a)$$
+
+Displaying math formulas in Confluence requires the extension [LaTeX Math for Confluence - Math Formula & Equations](https://help.narva.net/latex-math-for-confluence/).
+
 ### Ignoring files
 
 Skip files in a directory with rules defined in `.mdignore`. Each rule should occupy a single line. Rules follow the syntax (and constraints) of [fnmatch](https://docs.python.org/3/library/fnmatch.html#fnmatch.fnmatch). Specifically, `?` matches any single character, and `*` matches zero or more characters. For example, use `up-*.md` to exclude Markdown files that start with `up-`. Lines that start with `#` are treated as comments.
@@ -301,6 +348,20 @@ Files that don't have the extension `*.md` are skipped automatically. Hidden dir
 
 Relative paths to items in a nested directory are not supported. You must put `.mdignore` in the same directory where the items to be skipped reside.
 
+If you add the `synchronized` attribute to JSON or YAML front-matter with the value `false`, the document content (including attachments) and metadata (e.g. tags) will not be synchronized with Confluence:
+
+```yaml
+---
+title: "Collaborating with other teams"
+page_id: "19830101"
+synchronized: false
+---
+
+This Markdown document is neither parsed, nor synchronized with Confluence.
+```
+
+This is useful if you have a page in a hierarchy that participates in parent-child relationships but whose content is edited directly in Confluence. Specifically, these documents can be referenced with relative links from other Markdown documents in the file system tree.
+
 ### Page title
 
 *md2conf* makes a best-effort attempt at setting the Confluence wiki page title when it publishes a Markdown document the first time. The following are probed in this order:
@@ -326,12 +387,34 @@ Any previously assigned labels are discarded. As per Confluence terminology, new
 
 If a document has no `tags` attribute, existing Confluence labels are left intact.
 
-### Converting diagrams
+### Content properties
+
+The front-matter attribute `properties` in a Markdown document allows setting Confluence content properties on a page. Confluence content properties are a way to store structured metadata in the form of key-value pairs directly on Confluence content. The values in content properties are represented as JSON objects.
+
+Some content properties have special meaning to Confluence. For example, the following properties cause Confluence to display a wiki page with content confined to a fixed width in regular view mode, and taking the full page width in draft mode:
+
+```yaml
+---
+properties:
+  content-appearance-published: fixed-width
+  content-appearance-draft: full-width
+---
+```
+
+The attribute `properties` is parsed as a dictionary with keys of type string and values of type JSON. *md2conf* passes JSON values to Confluence REST API unchanged.
+
+### draw\.io diagrams
+
+With the command-line option `--no-render-drawio` (default), editable diagram data is extracted from images with embedded draw\.io diagrams (`*.drawio.png` and `*.drawio.svg`), and uploaded to Confluence as attachments. `*.drawio` and `*.drawio.xml` files are uploaded as-is. You need a [marketplace app](https://marketplace.atlassian.com/apps/1210933/draw-io-diagrams-uml-bpmn-aws-erd-flowcharts) to view and edit these diagrams on a Confluence page.
+
+With the command-line option `--render-drawio`, images with embedded draw\.io diagrams (`*.drawio.png` and `*.drawio.svg`) are uploaded unchanged, and shown on the Confluence page as images. These diagrams are not editable in Confluence. When both an SVG and a PNG image is available, PNG is preferred. `*.drawio` and `*.drawio.xml` files are converted into PNG or SVG images by invoking draw\.io as a command-line utility, and the generated images are uploaded to Confluence as attachments, and shown as images.
+
+### Mermaid diagrams
 
 You can include [Mermaid diagrams](https://mermaid.js.org/) in your Markdown documents to create visual representations of systems, processes, and relationships. When a Markdown document contains a code block with the language specifier `mermaid`, *md2conf* offers two options to publish the diagram:
 
-1. Pre-render into an image. The code block is interpreted by and converted into a PNG or SVG image with the Mermaid diagram utility [mermaid-cli](https://github.com/mermaid-js/mermaid-cli). The generated image is then uploaded to Confluence as an attachment to the page. This is the approach we use and support.
-2. Render on demand. The code block is transformed into a [diagram macro](https://atlasauthority.atlassian.net/wiki/spaces/MARKDOWNCLOUD/pages/2946826241/Diagram+Macro), which is processed by Confluence. You need a [Confluence plugin](https://marketplace.atlassian.com/apps/1211438/markdown-html-plantuml-latex-diagrams-open-api-mermaid) to turn macro definitions into images when a Confluence page is visited. This is a contributed feature. As authors of *md2conf*, we don't endorse or support any particular Confluence plugin.
+1. Pre-render into an image (command-line option `--render-mermaid`). The code block is interpreted by and converted into a PNG or SVG image with the Mermaid diagram utility [mermaid-cli](https://github.com/mermaid-js/mermaid-cli). The generated image is then uploaded to Confluence as an attachment to the page. This is the approach we use and support.
+2. Display on demand (command-line option `--no-render-mermaid`). The code block is transformed into a [diagram macro](https://atlasauthority.atlassian.net/wiki/spaces/MARKDOWNCLOUD/pages/2946826241/Diagram+Macro), which is processed by Confluence. You need a [marketplace app](https://marketplace.atlassian.com/apps/1211438/markdown-html-plantuml-latex-diagrams-open-api-mermaid) to turn macro definitions into images when a Confluence page is visited.
 
 If you are running into issues with the pre-rendering approach (e.g. misaligned labels in the generated image), verify if `mermaid-cli` can process the Mermaid source:
 
@@ -357,8 +440,9 @@ Use the `--help` switch to get a full list of supported command-line options:
 
 ```console
 $ python3 -m md2conf --help
-usage: md2conf [-h] [--version] [-d DOMAIN] [-p PATH] [--api-url API_URL] [-u USERNAME] [-a API_KEY] [-s SPACE] [-l {debug,info,warning,error,critical}] [-r ROOT_PAGE] [--keep-hierarchy] [--generated-by GENERATED_BY]
-               [--no-generated-by] [--render-mermaid] [--no-render-mermaid] [--render-mermaid-format {png,svg}] [--heading-anchors] [--ignore-invalid-url] [--local] [--headers [KEY=VALUE ...]] [--webui-links]
+usage: md2conf [-h] [--version] [-d DOMAIN] [-p PATH] [--api-url API_URL] [-u USERNAME] [-a API_KEY] [-s SPACE] [-l {debug,info,warning,error,critical}] [-r ROOT_PAGE] [--keep-hierarchy] [--flatten-hierarchy]
+               [--generated-by GENERATED_BY] [--no-generated-by] [--render-drawio] [--no-render-drawio] [--render-mermaid] [--no-render-mermaid] [--render-mermaid-format {png,svg}] [--heading-anchors]
+               [--no-heading-anchors] [--ignore-invalid-url] [--local] [--headers [KEY=VALUE ...]] [--webui-links]
                mdpath
 
 positional arguments:
@@ -367,28 +451,30 @@ positional arguments:
 options:
   -h, --help            show this help message and exit
   --version             show program's version number and exit
-  -d DOMAIN, --domain DOMAIN
-                        Confluence organization domain.
-  -p PATH, --path PATH  Base path for Confluence (default: '/wiki/').
+  -d, --domain DOMAIN   Confluence organization domain.
+  -p, --path PATH       Base path for Confluence (default: '/wiki/').
   --api-url API_URL     Confluence API URL. Required for scoped tokens. Refer to documentation how to obtain one.
-  -u USERNAME, --username USERNAME
+  -u, --username USERNAME
                         Confluence user name.
-  -a API_KEY, --apikey API_KEY, --api-key API_KEY
+  -a, --apikey, --api-key API_KEY
                         Confluence API key. Refer to documentation how to obtain one.
-  -s SPACE, --space SPACE
-                        Confluence space key for pages to be published. If omitted, will default to user space.
-  -l {debug,info,warning,error,critical}, --loglevel {debug,info,warning,error,critical}
+  -s, --space SPACE     Confluence space key for pages to be published. If omitted, will default to user space.
+  -l, --loglevel {debug,info,warning,error,critical}
                         Use this option to set the log verbosity.
   -r ROOT_PAGE          Root Confluence page to create new pages. If omitted, will raise exception when creating new pages.
   --keep-hierarchy      Maintain source directory structure when exporting to Confluence.
+  --flatten-hierarchy   Flatten directories with no index.md or README.md when exporting to Confluence.
   --generated-by GENERATED_BY
                         Add prompt to pages (default: 'This page has been generated with a tool.').
   --no-generated-by     Do not add 'generated by a tool' prompt to pages.
-  --render-mermaid      Render Mermaid diagrams as image files and add as attachments.
-  --no-render-mermaid   Inline Mermaid diagram in Confluence page.
+  --render-drawio       Render draw.io diagrams as image files and add as attachments. (Converter required.)
+  --no-render-drawio    Inline draw.io diagram in Confluence page. (Marketplace app required.)
+  --render-mermaid      Render Mermaid diagrams as image files and add as attachments. (Converter required.)
+  --no-render-mermaid   Inline Mermaid diagram in Confluence page. (Marketplace app required.)
   --render-mermaid-format {png,svg}
-                        Format for rendering Mermaid diagrams (default: 'png').
+                        Format for rendering Mermaid and draw.io diagrams (default: 'png').
   --heading-anchors     Place an anchor at each section heading with GitHub-style same-page identifiers.
+  --no-heading-anchors  Don't place an anchor at each section heading.
   --ignore-invalid-url  Emit a warning but otherwise ignore relative URLs that point to ill-specified locations.
   --local               Write XHTML-based Confluence Storage Format files locally without invoking Confluence API.
   --headers [KEY=VALUE ...]
@@ -437,3 +523,7 @@ FROM leventehunyadi/md2conf:latest
 
 CMD ["-d", "example.atlassian.net", "-u", "levente.hunyadi@instructure.com", "-a", "0123456789abcdef", "-s", "SPACE", "./"]
 ```
+
+[^math]: Requires installing Confluence plugin [LaTeX Math for Confluence - Math Formula & Equations](https://help.narva.net/latex-math-for-confluence/).
+[^drawio]: Converting draw\.io diagrams to images before uploading to Confluence requires an installation of [draw.io](https://www.drawio.com/). Editable draw\.io diagrams require separate marketplace app.
+[^mermaid]: Converting Mermaid diagrams to images before uploading to Confluence requires [mermaid-cli](https://github.com/mermaid-js/mermaid-cli). Displaying Mermaid diagrams on the fly requires separate marketplace app.

markdown_to_confluence-0.4.2.dist-info/RECORD

@@ -0,0 +1,27 @@
+markdown_to_confluence-0.4.2.dist-info/licenses/LICENSE,sha256=Pv43so2bPfmKhmsrmXFyAvS7M30-1i1tzjz6-dfhyOo,1077
+md2conf/__init__.py,sha256=XAJAgUDrYS3PdOzoo2BQ-rM3PbQWOrOW2kPt5iJ8xY0,402
+md2conf/__main__.py,sha256=qyboDihyVTm0EZa_c3AFWF1AojhL8-bww_kISAa5nHQ,10130
+md2conf/api.py,sha256=DbG1udDb9ti4OjqgSW3DSuHwxKNFPVDTkhjnaB1GNMI,37193
+md2conf/application.py,sha256=X_V4KdFACHwl5Nt4BIHQyhtecOqNOzknrPyPTW0d4Z0,8185
+md2conf/collection.py,sha256=EobgMRJgkYloWlY03NZJ52MRC_SGLpTVCHkltDbQyt0,837
+md2conf/converter.py,sha256=Eg6emS77GQAkhbXutaRjHxcBFgmXp_4z_zOAmBfqxUY,54360
+md2conf/drawio.py,sha256=G_pD2nafl7dXuFK_4MBiEUl0ZZGNuagnHw6GFOrev94,6717
+md2conf/emoji.py,sha256=UzDrxqFo59wHmbbJmMNdn0rYFDXbZE4qirOM-_egzXc,2603
+md2conf/entities.dtd,sha256=M6NzqL5N7dPs_eUA_6sDsiSLzDaAacrx9LdttiufvYU,30215
+md2conf/extra.py,sha256=VuMxuOnnC2Qwy6y52ukIxsaYhrZArRqMmRHRE4QZl8g,687
+md2conf/local.py,sha256=Ph-cGc_JQ1SkvuZ_Jxn37dlpaKZYKLVPBnsk5CGSVnk,3548
+md2conf/matcher.py,sha256=m5rZjYZSjhKfdeKS8JdPq7cG861Mc6rVZBkrIOZTHGE,6916
+md2conf/mermaid.py,sha256=f0x7ISj-41ZMh4zTAFPhIWwr94SDcsVZUc1NWqmH_G4,2508
+md2conf/metadata.py,sha256=LzZM-oPNnzCULmLhF516tPlV5zZBknccwMHt8Nan-xg,1007
+md2conf/processor.py,sha256=59XDWKgTvJwEZ1y52VfRkM67K2-Ivh7kGD6Eg2tfG9c,9713
+md2conf/properties.py,sha256=RC1jY_TKVbOv2bJxXn27Fj4fNWzyoNUQt6ltgUyVQAQ,3987
+md2conf/puppeteer-config.json,sha256=-dMTAN_7kNTGbDlfXzApl0KJpAWna9YKZdwMKbpOb60,159
+md2conf/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+md2conf/scanner.py,sha256=Cyvjab8tBvKgubttQvNagS8nailuTvFBqUGoiX5MNp8,5351
+md2conf/xml.py,sha256=HoKJfF1yRZ3Gk8jTS-kRpOqVs0nQJZyr56l0Fo3y9fs,2193
+markdown_to_confluence-0.4.2.dist-info/METADATA,sha256=ggIrg30RRTvk3ax2LKC_wKjMhOEhrXOYVrSwvb2dDbw,29495
+markdown_to_confluence-0.4.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+markdown_to_confluence-0.4.2.dist-info/entry_points.txt,sha256=F1zxa1wtEObtbHS-qp46330WVFLHdMnV2wQ-ZorRmX0,50
+markdown_to_confluence-0.4.2.dist-info/top_level.txt,sha256=_FJfl_kHrHNidyjUOuS01ngu_jDsfc-ZjSocNRJnTzU,8
+markdown_to_confluence-0.4.2.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+markdown_to_confluence-0.4.2.dist-info/RECORD,,

md2conf/__init__.py

@@ -5,7 +5,7 @@ Parses Markdown files, converts Markdown content into the Confluence Storage For
 Confluence API endpoints to upload images and content.
 """
 
-__version__ = "0.4.0"
+__version__ = "0.4.2"
 __author__ = "Levente Hunyadi"
 __copyright__ = "Copyright 2022-2025, Levente Hunyadi"
 __license__ = "MIT"

md2conf/__main__.py

@@ -15,7 +15,7 @@ import os.path
 import sys
 import typing
 from pathlib import Path
-from typing import Any, Literal, Optional, Sequence, Union
+from typing import Any, Iterable, Literal, Optional, Sequence, Union
 
 import requests
 
@@ -26,11 +26,7 @@ from .converter import ConfluenceDocumentOptions, ConfluencePageID
 from .extra import override
 from .local import LocalConverter
 from .metadata import ConfluenceSiteMetadata
-from .properties import (
-    ArgumentError,
-    ConfluenceConnectionProperties,
-    ConfluenceSiteProperties,
-)
+from .properties import ArgumentError, ConfluenceConnectionProperties, ConfluenceSiteProperties
 
 
 class Arguments(argparse.Namespace):
@@ -47,6 +43,7 @@ class Arguments(argparse.Namespace):
     root_page: Optional[str]
     keep_hierarchy: bool
     generated_by: Optional[str]
+    render_drawio: bool
     render_mermaid: bool
     diagram_output_format: Literal["png", "svg"]
     local: bool
@@ -71,21 +68,37 @@ class KwargsAppendAction(argparse.Action):
             raise argparse.ArgumentError(
                 self,
                 f'Could not parse argument "{values}". It should follow the format: k1=v1 k2=v2 ...',
-            )
+            ) from None
         setattr(namespace, self.dest, d)
 
 
+class PositionalOnlyHelpFormatter(argparse.HelpFormatter):
+    def _format_usage(
+        self,
+        usage: Optional[str],
+        actions: Iterable[argparse.Action],
+        groups: Iterable[argparse._MutuallyExclusiveGroup],
+        prefix: Optional[str],
+    ) -> str:
+        # filter only positional arguments
+        positional_actions = [a for a in actions if not a.option_strings]
+
+        # format usage string with only positional arguments
+        usage_str = super()._format_usage(usage, positional_actions, groups, prefix).rstrip()
+
+        # insert [OPTIONS] as a placeholder for all options (detailed below)
+        usage_str += " [OPTIONS]\n"
+
+        return usage_str
+
+
 def main() -> None:
-    parser = argparse.ArgumentParser()
+    parser = argparse.ArgumentParser(formatter_class=PositionalOnlyHelpFormatter)
     parser.prog = os.path.basename(os.path.dirname(__file__))
     parser.add_argument("--version", action="version", version=__version__)
-    parser.add_argument(
-        "mdpath", help="Path to Markdown file or directory to convert and publish."
-    )
+    parser.add_argument("mdpath", help="Path to Markdown file or directory to convert and publish.")
     parser.add_argument("-d", "--domain", help="Confluence organization domain.")
-    parser.add_argument(
-        "-p", "--path", help="Base path for Confluence (default: '/wiki/')."
-    )
+    parser.add_argument("-p", "--path", help="Base path for Confluence (default: '/wiki/').")
     parser.add_argument(
         "--api-url",
         dest="api_url",
@@ -131,6 +144,12 @@ def main() -> None:
         default=False,
         help="Maintain source directory structure when exporting to Confluence.",
     )
+    parser.add_argument(
+        "--flatten-hierarchy",
+        dest="keep_hierarchy",
+        action="store_false",
+        help="Flatten directories with no index.md or README.md when exporting to Confluence.",
+    )
     parser.add_argument(
         "--generated-by",
         default="This page has been generated with a tool.",
@@ -143,25 +162,38 @@ def main() -> None:
         const=None,
         help="Do not add 'generated by a tool' prompt to pages.",
     )
+    parser.add_argument(
+        "--render-drawio",
+        dest="render_drawio",
+        action="store_true",
+        default=True,
+        help="Render draw.io diagrams as image files and add as attachments. (Installed utility required.)",
+    )
+    parser.add_argument(
+        "--no-render-drawio",
+        dest="render_drawio",
+        action="store_false",
+        help="Inline draw.io diagram in Confluence page. (Marketplace app required.)",
+    )
     parser.add_argument(
         "--render-mermaid",
         dest="render_mermaid",
         action="store_true",
         default=True,
-        help="Render Mermaid diagrams as image files and add as attachments.",
+        help="Render Mermaid diagrams as image files and add as attachments. (Installed utility required.)",
     )
     parser.add_argument(
         "--no-render-mermaid",
         dest="render_mermaid",
         action="store_false",
-        help="Inline Mermaid diagram in Confluence page.",
+        help="Inline Mermaid diagram in Confluence page. (Marketplace app required.)",
     )
     parser.add_argument(
         "--render-mermaid-format",
         dest="diagram_output_format",
         choices=["png", "svg"],
         default="png",
-        help="Format for rendering Mermaid diagrams (default: 'png').",
+        help="Format for rendering Mermaid and draw.io diagrams (default: 'png').",
     )
     parser.add_argument(
         "--heading-anchors",
@@ -169,6 +201,12 @@ def main() -> None:
         default=False,
         help="Place an anchor at each section heading with GitHub-style same-page identifiers.",
     )
+    parser.add_argument(
+        "--no-heading-anchors",
+        action="store_false",
+        dest="heading_anchors",
+        help="Don't place an anchor at each section heading.",
+    )
     parser.add_argument(
         "--ignore-invalid-url",
         action="store_true",
@@ -183,7 +221,7 @@ def main() -> None:
     )
     parser.add_argument(
         "--headers",
-        nargs="*",
+        nargs="+",
         required=False,
         action=KwargsAppendAction,
         metavar="KEY=VALUE",
@@ -212,6 +250,7 @@ def main() -> None:
         generated_by=args.generated_by,
         root_page_id=ConfluencePageID(args.root_page) if args.root_page else None,
         keep_hierarchy=args.keep_hierarchy,
+        render_drawio=args.render_drawio,
         render_mermaid=args.render_mermaid,
         diagram_output_format=args.diagram_output_format,
         webui_links=args.webui_links,