usage: md2conf mdpath [mdpath ...] [OPTIONS]
positional arguments:
mdpath Path to Markdown file or directory to convert and publish.
options:
-h, --help show this help message and exit
--version show program's version number and exit
-d, --domain DOMAIN Confluence organization domain. (env: CONFLUENCE_DOMAIN)
-p, --path PATH Base path for Confluence. (env: CONFLUENCE_PATH; default: '/wiki/')
--api-url API_URL Confluence API URL. Required for scoped tokens. Refer to documentation how
to obtain one. (env: CONFLUENCE_API_URL)
-u, --username USERNAME
Confluence user name. (env: CONFLUENCE_USER_NAME)
-a, --api-key API_KEY
Confluence API key. Refer to documentation how to obtain one. (env:
CONFLUENCE_API_KEY)
-s, --space SPACE Confluence space key for pages to be published. If omitted, will default
to user space. (env: CONFLUENCE_SPACE_KEY)
--api-version {v2,v1}
Confluence REST API version to use (v2 for Cloud, v1 for Data
Center/Server). (env: CONFLUENCE_API_VERSION; default: v2)
-l, --loglevel {debug,info,warning,error,critical}
Use this option to set the log verbosity.
-r CONFLUENCE_PAGE_ID
Confluence page to act as initial parent for creating new pages.
(deprecated)
--root-page CONFLUENCE_PAGE_ID
Confluence page to act as initial parent for creating new pages. Defaults
to space home page.
--keep-hierarchy Maintain source directory structure when exporting to Confluence.
--skip-hierarchy Flatten directories with no `index.md` or `README.md` when exporting to
Confluence. (default)
--title-prefix STR String to prepend to Confluence page title for each published page.
--no-title-prefix Use Markdown title to synchronize page. (default)
--generated-by MARKDOWN
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.
--overwrite Overwrite (manual) page changes that occurred since last synchronization.
(default)
--no-overwrite Skip pages with (manual) changes that occurred since last synchronization.
--attachment-sync {full,upsert,create}
Synchronization mode for Confluence page attachments. (default: full)
--comments {keep,remove,check-open}
Behavior for inline comments when page is updated. (default: remove)
--skip-update Skip saving Confluence page ID in Markdown files.
--keep-update Inject published Confluence page ID in Markdown files. (default)
--keep-state Keep the Confluence content state (rough draft, in progress, ready for
review, verified, etc.) when updating a page.
--skip-state Clear the Confluence content state when updating a page. (default)
--heading-anchors Place an anchor at each section heading with GitHub-style same-page
identifiers.
--no-heading-anchors Omit the extra anchor from section headings. (May break manually placed
same-page references.) (default)
--force-valid-url Raise an error when relative URLs point to an invalid location. (default)
--no-force-valid-url Emit a warning but otherwise ignore relative URLs that point to an invalid
location.
--skip-title-heading Remove the first heading from document body when it is used as the page
title (does not apply if title comes from front-matter).
--keep-title-heading Keep the first heading in document body even when used as page title.
(default)
--prefer-raster Prefer PNG over SVG when both exist. (default)
--no-prefer-raster Use SVG files directly instead of preferring PNG equivalents.
--render-drawio Render draw.io diagrams as image files. (Installed utility required to
covert.) (default)
--no-render-drawio Upload draw.io diagram sources as Confluence page attachments.
(Marketplace app required to display.)
--render-mermaid Render Mermaid diagrams as image files. (Installed utility required to
convert.) (default)
--no-render-mermaid Upload Mermaid diagram sources as Confluence page attachments.
(Marketplace app required to display.)
--render-plantuml Render PlantUML diagrams as image files. (Installed utility required to
convert.) (default)
--no-render-plantuml Upload PlantUML diagram sources as Confluence page attachments.
(Marketplace app required to display.)
--render-latex Render LaTeX formulas as image files. (Matplotlib required to convert.)
(default)
--no-render-latex Inline LaTeX formulas in Confluence page. (Marketplace app required to
display.)
--render-other Render other supported diagrams as image files. (Installed utilities
required to convert.) (default)
--no-render-other Upload other diagram sources as Confluence page attachments. (Marketplace
app required to display.)
--diagram-output-format {png,svg}
Format for rendering Mermaid and draw.io diagrams. (default: png)
--webui-links Enable Confluence Web UI links. (Typically required for on-prem versions
of Confluence.)
--no-webui-links Use hierarchical links including space and page ID. (default)
--task-lists Transform GitHub/GitLab-style task lists into Confluence task list
objects. (default)
--no-task-lists Keep task lists as regular itemized lists.
--user-mentions Transform `mailto:` links into Confluence user mentions (`@...`) with
name-based lookup. (default)
--no-user-mentions Keep `mailto:` links as regular links.
--use-panel Transform admonitions and alerts into a Confluence custom panel.
--no-use-panel Use standard Confluence macro types for admonitions and alerts (info, tip,
note and warning). (default)
--force-valid-language
Only allow supported languages in code blocks (unsupported languages are
ignored) (default)
--no-force-valid-language
Use unknown language names as-is (Confluence may still highlight code).
--layout-image-alignment {center,left,right,None}
Alignment for block-level images and formulas.
--layout-image-max-width INT
Maximum display width for images [px]. Wider images are scaled down for
page display.
--layout-table-width INT
Maximum table width in pixels.
--layout-table-display-mode {responsive,fixed}
Set table display mode. (default: responsive)
--layout-alignment {center,left,right,None}
Default alignment for block-level content.
--line-numbers Inject line numbers in Markdown source file to help localize conversion
errors.
--no-line-numbers Leave Markdown source file unmodified. (default)
--global-properties PATH
JSON or YAML file of Confluence content properties to merge for every
synchronized Markdown file.
--notify Notify users about changes when a Confluence page is updated.
--no-notify Trigger a minor edit on page updates, don't notify users about changes.
(default)
--ignore-invalid-url Emit a warning but otherwise ignore relative URLs that point to ill-
specified locations. (deprecated)
--local Write XHTML-based Confluence Storage Format files locally without invoking
Confluence API.
Options (67)
| Option | Description | Source |
|---|---|---|
-h, --help | show this help message and exit | help |
--version | show program's version number and exit | help |
-d, --domain DOMAIN | Confluence organization domain. | help |
-p, --path PATH | Base path for Confluence. | help |
--api-url API_URL | Confluence API URL. | help |
-u, --username USERNAME | Confluence user name. | help |
-a, --api-key API_KEY | Confluence API key. | help |
-s, --space SPACE | Confluence space key for pages to be published. | help |
--api-version v2 | Confluence REST API version to use (v2 for Cloud, v1 for Data Center/Server). | help |
-l, --loglevel debug | Use this option to set the log verbosity. | help |
-r CONFLUENCE_PAGE_ID | Confluence page to act as initial parent for creating new pages. | help |
--root-page CONFLUENCE_PAGE_ID | Confluence page to act as initial parent for creating new pages. | help |
--keep-hierarchy | Maintain source directory structure when exporting to Confluence. | help |
--skip-hierarchy | Flatten directories with no `index.md` or `README.md` when exporting to Confluence. | help |
--title-prefix STR | String to prepend to Confluence page title for each published page. | help |
--no-title-prefix | Use Markdown title to synchronize page. | help |
--generated-by MARKDOWN | Add prompt to pages. | help |
--no-generated-by | Do not add 'generated by a tool' prompt to pages. | help |
--overwrite | Overwrite (manual) page changes that occurred since last synchronization. | help |
--no-overwrite | Skip pages with (manual) changes that occurred since last synchronization. | help |
--attachment-sync full | Synchronization mode for Confluence page attachments. | help |
--comments keep | Behavior for inline comments when page is updated. | help |
--skip-update | Skip saving Confluence page ID in Markdown files. | help |
--keep-update | Inject published Confluence page ID in Markdown files. | help |
--keep-state | Keep the Confluence content state (rough draft, in progress, ready for review, verified, etc.) when updating a page. | help |
--skip-state | Clear the Confluence content state when updating a page. | help |
--heading-anchors | Place an anchor at each section heading with GitHub-style same-page identifiers. | help |
--no-heading-anchors | Omit the extra anchor from section headings. | help |
--force-valid-url | Raise an error when relative URLs point to an invalid location. | help |
--no-force-valid-url | Emit a warning but otherwise ignore relative URLs that point to an invalid location. | help |
--skip-title-heading | Remove the first heading from document body when it is used as the page title (does not apply if title comes from front-matter). | help |
--keep-title-heading | Keep the first heading in document body even when used as page title. | help |
--prefer-raster | Prefer PNG over SVG when both exist. | help |
--no-prefer-raster | Use SVG files directly instead of preferring PNG equivalents. | help |
--render-drawio | Render draw.io diagrams as image files. | help |
--no-render-drawio | Upload draw.io diagram sources as Confluence page attachments. | help |
--render-mermaid | Render Mermaid diagrams as image files. | help |
--no-render-mermaid | Upload Mermaid diagram sources as Confluence page attachments. | help |
--render-plantuml | Render PlantUML diagrams as image files. | help |
--no-render-plantuml | Upload PlantUML diagram sources as Confluence page attachments. | help |
--render-latex | Render LaTeX formulas as image files. | help |
--no-render-latex | Inline LaTeX formulas in Confluence page. | help |
--render-other | Render other supported diagrams as image files. | help |
--no-render-other | Upload other diagram sources as Confluence page attachments. | help |
--diagram-output-format png | Format for rendering Mermaid and draw.io diagrams. | help |
--webui-links | Enable Confluence Web UI links. | help |
--no-webui-links | Use hierarchical links including space and page ID. | help |
--task-lists | Transform GitHub/GitLab-style task lists into Confluence task list objects. | help |
--no-task-lists | Keep task lists as regular itemized lists. | help |
--user-mentions | Transform `mailto:` links into Confluence user mentions (`@...`) with name-based lookup. | help |
--no-user-mentions | Keep `mailto:` links as regular links. | help |
--use-panel | Transform admonitions and alerts into a Confluence custom panel. | help |
--no-use-panel | Use standard Confluence macro types for admonitions and alerts (info, tip, note and warning). | help |
--force-valid-language | Only allow supported languages in code blocks (unsupported languages are ignored) (default) | help |
--no-force-valid-language | Use unknown language names as-is (Confluence may still highlight code). | help |
--layout-image-alignment center | Alignment for block-level images and formulas. | help |
--layout-image-max-width INT | Maximum display width for images [px]. | help |
--layout-table-width INT | Maximum table width in pixels. | help |
--layout-table-display-mode responsive | Set table display mode. | help |
--layout-alignment center | Default alignment for block-level content. | help |
--line-numbers | Inject line numbers in Markdown source file to help localize conversion errors. | help |
--no-line-numbers | Leave Markdown source file unmodified. | help |
--global-properties PATH | JSON or YAML file of Confluence content properties to merge for every synchronized Markdown file. | help |
--notify | Notify users about changes when a Confluence page is updated. | help |
--no-notify | Trigger a minor edit on page updates, don't notify users about changes. | help |
--ignore-invalid-url | Emit a warning but otherwise ignore relative URLs that point to ill- specified locations. | help |
--local | Write XHTML-based Confluence Storage Format files locally without invoking Confluence API. | help |