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).
  • Math becomes a native Word equation, editable and selectable, for the common markdown-math subset. Beyond it the formula is drawn as a picture, and only what neither layer understands is printed as its own LaTeX source, with a warning.
  • 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(
  font_body="Calibri",
  font_mono="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)
  • Page geometry, fonts, banner toggles and locale come from the caller's style=, never from the document (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): 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 syntax highlighting and pre-measured page breaks, and covers a wider slice of LaTeX. 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.3.3.tar.gz (82.9 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.3.3-py3-none-any.whl (76.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for docmarq-0.3.3.tar.gz
Algorithm Hash digest
SHA256 e51f373b567587dd6cf351a9cee24f4b57ac9cd40bbff7c9c2bc82cdfd994aee
MD5 4c044199eb078110c8c46c18c069f27b
BLAKE2b-256 2157aead713151abc2d8ee1d7ef82185933664b133e35e8152ab9fd78eaa73c1

See more details on using hashes here.

Provenance

The following attestation bundles were made for docmarq-0.3.3.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.3.3-py3-none-any.whl.

File metadata

  • Download URL: docmarq-0.3.3-py3-none-any.whl
  • Upload date:
  • Size: 76.7 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.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 bb3a1e262cc5019c3ba906fbf1a2831260b4a3a5a82ed335f7d4130bb0aea1f0
MD5 9f009976b93ee33093809d0158129a22
BLAKE2b-256 95eaabc41a80443bc65ceefdd10a1f94038f8a59c9c9d891f6478a50c11dc61d

See more details on using hashes here.

Provenance

The following attestation bundles were made for docmarq-0.3.3-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

This release

0.3.3 This release

2 files

0.3.2

2 files

0.3.1

2 files

0.3.0

2 files

0.2.2

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