Skip to main content

DocMarQ

DOCX generation with a fluent API. Core is lean (just python-docx). Optional [md] extra adds markdown-to-DOCX rendering with banner headers, mermaid, GitHub callouts and more. Sibling library to pdfmarq with the same API shape and .docx output.

Philosophy

DocMarQ wraps python-docx (OOXML zip plumbing, content types, relationships) into a fluent paragraph/run API. You describe document flow; Word handles layout, pagination, and reflow on open.

  • Fluent paragraph/run model: doc.para("First.") opens a paragraph, doc.text(" with bold", bold=True) appends a styled run. Close with enter() or let the next block auto-open one.
  • One way per feature: doc.table(), doc.image(), doc.bullet(), doc.link(), no overloaded call signatures
  • Markdown is optional: core → 1 dep (python-docx), [md] adds markdown-it-py, mdit-py-plugins, PyYAML
  • Cross-library parity: API shape mirrors pdfmarq, including TableStyle, Styles, parse_color, rgb255, page sizes, and lang_style() for i18n. The same markdown source can target both PDF and DOCX.
  • Word-native output: opens cleanly in Word, LibreOffice, Google Docs. Templates .dotx / .docx are respected, so themes and styles carry over.

Trade-offs:

  • No cursor or coordinate control. Word owns layout. Great for content-driven documents, not for pixel-perfect grids (use pdfmarq if you need that).
  • No math support. Word's equation editor is OOXML-native and out of scope. For math-heavy docs use pdfmarq with matplotlib.
  • Syntax highlighting in code blocks is not rendered yet. The language argument is accepted but ignored.
  • The dep tree is small but python-docx is the only path to OOXML. If it can't express something (e.g. complex equation OMML), neither can DocMarQ. Drop to doc.doc for raw python-docx access.

Install

pip install docmarq      # core: python-docx
pip install docmarq[md]  # + markdown rendering stack

Examples

from docmarq import DOCX
# Fluent core API
with DOCX("report.docx") as doc:
  doc.font("Calibri", 20, "Bold").para("Quarterly Report")
  doc.font(size=11, mode="Regular")
  doc.para("Revenue up 23% year-over-year.")
  doc.table(
    [["Q1", "120k"], ["Q2", "148k"], ["Q3", "172k"]],
    header=["Quarter", "Revenue"],
    aligns=["C", "R"],
  )
  doc.image("chart.png", width=180, height=80)
  doc.link("google.com", url="https://google.com")
from docmarq.md import md_to_docx, MarkdownStyle
# Markdown to DOCX
style = MarkdownStyle(
  body_family="Calibri",
  mono_family="Consolas",
  line_height=1.4,
)
md_to_docx(open("doc.md").read(), "doc.docx", style=style)

See example.py for an end-to-end CLI script: language preset, Word-native fonts, link_root for cross-document references, and base_dir for relative images.

Markdown features

  • GitHub-flavored markdown (tables, fenced code, lists, strikethrough)
  • YAML frontmatter rendered as a page-1 banner (logo, status badge, version, sign block)
  • Nested render: block in frontmatter controls page geometry, fonts, banner toggles, locale (see md-guide)
  • Built-in language presets (en|pl|de|fr|es|it|cs|sk) via lang_style(): covers banner labels, callouts, date format
  • Skip-duplicate-title: drops # X when it matches frontmatter title
  • Auto-slugged headings with clickable [text](#anchor) internal links (unicode-aware)
  • Local-path links configurable via link_root + link_base (or per-doc YAML base:)
  • Mermaid diagrams via mermaid-cli (local) or mermaid.ink (network fallback), with a shared cache with pdfmarq
  • Footnotes, emoji shortcodes :rocket:, nested lists, blockquotes, GitHub callouts (> [!NOTE], > [!WARNING], …)
  • Images with size caps for block and inline use (![alt](logo.svg) works inline at x-height)
  • Headerless single-row tables for label/value cards
  • Setext-heading-with-image recovery: ![](img.svg)\n--- renders as block image + <hr> instead of a thumbnail-sized setext h2

Not supported (use pdfmarq if you need them): math formulas, syntax highlighting in code blocks, deferred Page N/M totals (Word's page-numbering fields compute live).

Modules

Module Description Docs
docmarq Core DOCX API (fluent paragraph/run model) docmarq/readme.md
docmarq.md Markdown-to-DOCX renderer (optional [md] extra) docmarq/md/readme.md

See also

Need PDF instead of .docx? Check PDFMarQ, the sibling library with the same API shape and PDF output. It adds math formulas, syntax highlighting, and pre-measured page breaks. Otherwise feature parity (banner, callouts, mermaid, lang presets).

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

docmarq-0.2.2.tar.gz (75.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

docmarq-0.2.2-py3-none-any.whl (72.6 kB view details)

Uploaded Python 3

File details

Details for the file docmarq-0.2.2.tar.gz.

File metadata

  • Download URL: docmarq-0.2.2.tar.gz
  • Upload date:
  • Size: 75.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for docmarq-0.2.2.tar.gz
Algorithm Hash digest
SHA256 80af4754aa3865f6d2c18f00accf8be631abbc62351b0438863ebea46cd63966
MD5 1d3bb86ebc73fd5c1322c4ba1809b64e
BLAKE2b-256 0c907ee86060d4800b60341ec48b3f1bcd5cbf0f42eef5a370236d1eb1292984

See more details on using hashes here.

Provenance

The following attestation bundles were made for docmarq-0.2.2.tar.gz:

Publisher: publish.yml on Xaeian/DocMarQ

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file docmarq-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: docmarq-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 72.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for docmarq-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 b451a9636e0bea5eaf2d6194c78c8903c8547fd7e0c418c544b646d6479fa296
MD5 fb588437528e604799a5b8d433854e84
BLAKE2b-256 4679f6117c8254cc6c5e20f73578ec225a54dbfdee638f73ce40616e9d72d400

See more details on using hashes here.

Provenance

The following attestation bundles were made for docmarq-0.2.2-py3-none-any.whl:

Publisher: publish.yml on Xaeian/DocMarQ

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.3.6

2 files

0.3.5

2 files

0.3.4

2 files

0.3.3

2 files

0.3.2

2 files

0.3.1

2 files

0.3.0

2 files

This release

0.2.2 This release

2 files

0.2.1

2 files

0.2.0

2 files

0.1.1

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page